openapi: 3.1.0 paths: /v1/ping: get: description: >- Checks the status of the system by sending a ping request. This endpoint is used to verify the system's availability and responsiveness. operationId: AppController_ping parameters: [] responses: '200': description: Successful response. security: [] summary: Ping the system. tags: - Healthcheck /v1/auth/login: post: description: >- This endpoint allows a registered user to log in by providing their email address and password. With MFA enabled, the first step returns a pending result and sets two HttpOnly challenge cookies; retain them for /v1/auth/mfa/challenge and the subsequent MFA operations. Native credentials are issued only after MFA completion. The challenge has a fixed five-minute deadline. Keyed MFA login requires X-MFA-Login-Nonce: a client-generated, cryptographically random 32-byte base64url secret retained by that browser before the first request. Repeating the same Idempotency-Key, nonce, body and frontend origin reuses the original challenge; after factor proof, its original challenge cookies are required. A login retry never clears a completed native session. operationId: AuthController_login parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: X-MFA-Login-Nonce in: header description: >- Required with Idempotency-Key when MFA is enabled. Generate a private random 32-byte unpadded base64url nonce before the first request and retain it for retries in the same browser. Independent of the idempotency key. required: false schema: type: string pattern: ^[A-Za-z0-9_-]{43}$ requestBody: required: true content: application/json: schema: description: Authentication login body schema type: object properties: email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string password: minLength: 1 maxLength: 255 type: string redirect: maxLength: 2048 description: >- Requested platform destination after sign-in. MFA stores a validated internal path; unsafe or authentication-page destinations fall back to /dashboard. example: /settings/password type: string required: - email - password example: email: john@mail.com password: password redirect: /settings/password description: Request payload for Authenticate user via email and password. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - description: Access token renewal type: object properties: userId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID accessToken: minLength: 1 maxLength: 700 description: Access token provided when user logs in. example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c type: string expiresIn: description: Timestamp of access token expiration date type: number refreshToken: minLength: 1 maxLength: 700 description: Access token provided when user logs in. example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c type: string refreshTokenExpiresAt: description: Timestamp of refresh token expiration date type: number required: - userId - accessToken - expiresIn - refreshToken - refreshTokenExpiresAt - type: object properties: state: description: >- Existing-factor verification or first-time authenticator enrollment is required. example: mfa_required anyOf: - const: mfa_required type: string - const: enrollment_required type: string expiresAt: description: Fixed challenge expiration as Unix milliseconds. example: 1791673500000 type: number nextPath: description: Frontend route for completing MFA. example: /mfa const: /mfa type: string required: - state - expiresAt - nextPath required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: userId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f accessToken: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c expiresIn: 0 refreshToken: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c refreshTokenExpiresAt: 0 security: [] summary: Authenticate user via email and password. tags: - Authentication /v1/auth/logout: get: description: >- This endpoint logs out the currently authenticated user and invalidates their access token. operationId: AuthController_logout parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: content security: [] summary: Terminate user session. tags: - Authentication /v1/auth/access-token: post: description: >- Allows a user with a valid refresh token to renew their access token, extending their session without needing to log in again. operationId: AuthController_renewAccessToken parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Authentication access token body schema type: object properties: refreshToken: minLength: 1 maxLength: 700 description: Access token provided when user logs in. example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c type: string required: - refreshToken example: refreshToken: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c description: Request payload for Renew access token. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Access token renewal type: object properties: userId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID accessToken: minLength: 1 maxLength: 700 description: Access token provided when user logs in. example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c type: string expiresIn: description: Timestamp of access token expiration date type: number refreshToken: minLength: 1 maxLength: 700 description: Access token provided when user logs in. example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c type: string refreshTokenExpiresAt: description: Timestamp of refresh token expiration date type: number required: - userId - accessToken - expiresIn - refreshToken - refreshTokenExpiresAt required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: userId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f accessToken: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c expiresIn: 0 refreshToken: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c refreshTokenExpiresAt: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Renew access token. tags: - Authentication /v1/auth/passwords/reset: post: description: >- Sends an email with a password reset link to the user’s registered email address. operationId: AuthController_resetPassword parameters: [] requestBody: required: true content: application/json: schema: description: Authentication reset password body schema type: object properties: email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string source: const: recircle type: string required: - email example: email: john@mail.com source: recircle description: Request payload for Request password reset. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: content security: [] summary: Request password reset. tags: - Authentication /v1/auth/passwords/change: post: description: >- Allows a user to change their current password by providing their old password and a new one. operationId: AuthController_changePassword parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Authentication change password body schema anyOf: - title: Reset password type: object properties: token: minLength: 1 maxLength: 700 description: Access token provided when user logs in. example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c type: string newPassword: minLength: 8 maxLength: 72 format: new-password description: >- Password with at least 8 Unicode characters and at most 72 UTF-8 bytes. Spaces are preserved. type: string required: - token - newPassword - title: Change password type: object properties: oldPassword: minLength: 1 maxLength: 255 description: User password example: SuperSecret! type: string newPassword: minLength: 8 maxLength: 72 format: new-password description: >- Password with at least 8 Unicode characters and at most 72 UTF-8 bytes. Spaces are preserved. type: string required: - oldPassword - newPassword description: Request payload for Change user password. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Change user password. tags: - Authentication /v1/auth/marketplace/sign-up: post: description: >- Creates a new marketplace user account with the provided email address and user details. operationId: AuthController_createMarketplaceUser parameters: [] requestBody: required: true content: application/json: schema: description: Create marketplace user body schema type: object properties: firstName: minLength: 1 maxLength: 255 type: string lastName: minLength: 1 maxLength: 255 type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string password: minLength: 8 maxLength: 72 format: new-password description: >- Password with at least 8 Unicode characters and at most 72 UTF-8 bytes. Spaces are preserved. type: string password2: minLength: 8 maxLength: 72 format: new-password description: >- Password with at least 8 Unicode characters and at most 72 UTF-8 bytes. Spaces are preserved. type: string source: const: recircle type: string required: - firstName - lastName - email - password - password2 description: Request payload for Register marketplace user. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Member type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Member UUID firstName: description: Member first name example: John type: string lastName: description: Member last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string avatar: description: URL to avatar assigned to a member example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' gender: anyOf: - description: 'Member''s gender: male, female, non-binary' example: male anyOf: - const: male type: string - const: female type: string - const: non-binary type: string - type: 'null' timezone: description: >- Timezone to help member on dates and other locale purposes example: Europe/Berlin type: string language: description: >- Language that is preferable for user. Uses ISO 639-1 or BCP47 format. example: en type: string entity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy role: description: 'Member''s role. Possible values: member, admin' example: admin anyOf: - anyOf: - const: admin type: string - const: member type: string - type: string user: description: User type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID firstName: description: User first name example: John type: string lastName: description: User last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string emailVerified: default: false description: Whether user email verified or not example: true type: boolean emailVerifiedAt: description: Timestamp of email verification date example: 1686042132022 type: number admin: default: false description: Whether user is admin or not example: true type: boolean active: default: false description: Whether user is active or not example: true type: boolean activatedAt: description: Timestamp of user account activation date example: 1686042132022 type: number lastLogin: description: Timestamp of user last login date example: 1686042132022 type: number resetPasswordNextLogin: default: false description: >- Whether the user must update its password on next login example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - emailVerified - admin - active - resetPasswordNextLogin - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - gender - timezone - entity - role - user - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com gender: male timezone: Europe/Berlin entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f role: admin user: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com emailVerified: true admin: true active: true resetPasswordNextLogin: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Register marketplace user. tags: - Authentication /v1/auth/sso/{provider}/start: get: description: >- Kicks off the OIDC Authorization Code + PKCE flow for the chosen provider. Creates a short-lived transaction and redirects to the provider's authorize endpoint. operationId: AuthController_startSso parameters: - name: provider required: true in: path schema: type: string description: SSO provider identifier. example: google - name: op required: false in: query schema: description: 'Operation type: login or signup' anyOf: - const: login type: string - const: signup type: string description: 'Operation type: login or signup' example: login - name: invitationId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Invitation id value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity id value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: redirect required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Redirect value used by this operation. example: redirect - name: login_hint required: false in: query schema: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string description: Email address example: john@mail.com - name: timezone required: false in: query schema: type: string description: Timezone value used by this operation. example: Europe/Lisbon responses: '302': description: Redirects the client to the next authentication step. security: [] summary: Start SSO login/signup with an external provider. tags: - Authentication /v1/auth/sso/{provider}/callback: get: description: >- Handles the OIDC callback: exchanges the authorization code, validates the ID token, resolves/creates the local user, sets cookies and redirects back to the frontend. operationId: AuthController_ssoCallback parameters: - name: provider required: true in: path schema: type: string description: SSO provider identifier. example: google - name: state required: true in: query schema: type: string description: State value used by this operation. example: state - name: code required: false in: query schema: type: string description: Code value used by this operation. example: ABC123 - name: error required: false in: query schema: type: string description: Error value used by this operation. example: error - name: error_description required: false in: query schema: type: string description: Error description value used by this operation. example: error-description responses: '200': description: Successful response. security: [] summary: Finish SSO login/signup. tags: - Authentication /v1/auth/mfa/challenge: get: description: >- Keep both opaque challenge cookies issued by password login or the SSO callback. Returns the current stage and fixed expiration; setup secrets appear only during enrollment, and recovery codes only in save_codes. Management challenges additionally require the initiating native session or bearer token. MFA must be enabled. operationId: AuthMfaController_challenge parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- Browser-bound MFA state. Enrollment secrets and recovery codes appear only in their respective stages. anyOf: - additionalProperties: false description: >- Challenge state without enrollment secrets or recovery codes. type: object properties: purpose: description: Operation bound to this challenge. example: login anyOf: - const: login type: string - const: factor_replace type: string - const: recovery_regenerate type: string expiresAt: description: >- Fixed challenge expiration as Unix milliseconds. Reading or replaying the challenge does not extend it. example: 1791673500000 type: number email: description: Masked account email. example: t***@example.test type: string returnPath: description: Validated platform path to use after completion. example: /dashboard type: string recoveryReference: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Challenge identifier used to match a verified manual recovery request. stage: description: >- verify awaits an existing factor; verified permits login completion; recovery_authorized permits recovery re-enrollment; action_authorized permits code regeneration; complete retains the bounded retry receipt. anyOf: - const: verify type: string - const: verified type: string - const: recovery_authorized type: string - const: action_authorized type: string - const: complete type: string required: - purpose - expiresAt - email - returnPath - recoveryReference - stage - additionalProperties: false description: >- Enrollment challenge. Confirm the new authenticator before acknowledging and completing setup. type: object properties: purpose: description: Operation bound to this challenge. example: login anyOf: - const: login type: string - const: factor_replace type: string - const: recovery_regenerate type: string expiresAt: description: >- Fixed challenge expiration as Unix milliseconds. Reading or replaying the challenge does not extend it. example: 1791673500000 type: number email: description: Masked account email. example: t***@example.test type: string returnPath: description: Validated platform path to use after completion. example: /dashboard type: string recoveryReference: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Challenge identifier used to match a verified manual recovery request. stage: description: >- Authenticator setup or re-enrollment after authorized recovery. anyOf: - const: enroll type: string - const: recover_enroll type: string manualKey: description: >- Base32 setup secret, returned only during enrollment. The example is a public test secret. example: GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ type: string accountLabel: description: Account label displayed by the authenticator. example: Minespider:test@example.test type: string provisioningUri: description: >- Standard otpauth URI to render as a QR code. The example uses a public test secret. example: >- otpauth://totp/Minespider%3Atest%40example.test?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=Minespider&algorithm=SHA1&digits=6&period=30 type: string required: - purpose - expiresAt - email - returnPath - recoveryReference - stage - manualKey - accountLabel - provisioningUri - additionalProperties: false description: >- Codes are returned only while the challenge is in save_codes; no setup secret is returned in this stage. type: object properties: purpose: description: Operation bound to this challenge. example: login anyOf: - const: login type: string - const: factor_replace type: string - const: recovery_regenerate type: string expiresAt: description: >- Fixed challenge expiration as Unix milliseconds. Reading or replaying the challenge does not extend it. example: 1791673500000 type: number email: description: Masked account email. example: t***@example.test type: string returnPath: description: Validated platform path to use after completion. example: /dashboard type: string recoveryReference: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Challenge identifier used to match a verified manual recovery request. stage: description: New codes await explicit save acknowledgment. const: save_codes type: string recoveryCodes: minItems: 10 maxItems: 10 uniqueItems: true description: >- Ten single-use recovery codes. Store them before completing. Regenerated codes replace the old set only after completion. example: - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0001 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0002 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0003 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0004 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0005 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0006 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0007 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0008 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0009 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-000A type: array items: pattern: ^[A-F0-9]{4}(-[A-F0-9]{4}){7}$ type: string required: - purpose - expiresAt - email - returnPath - recoveryReference - stage - recoveryCodes required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: purpose: login expiresAt: 1791673500000 email: t***@example.test returnPath: /dashboard recoveryReference: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f stage: verify '401': description: >- Your authentication request expired or is no longer valid. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: invalid_challenge: value: _meta: success: false statusCode: 401 errorCode: '010361' messages: - >- Your authentication request expired or is no longer valid. Start again. content: null '403': description: This authentication request cannot perform that action. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: forbidden: value: _meta: success: false statusCode: 403 errorCode: '010367' messages: - This authentication request cannot perform that action. content: null '409': description: Your account security changed. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: conflict: value: _meta: success: false statusCode: 409 errorCode: '010363' messages: - Your account security changed. Start again. content: null '503': description: >- Multi-factor authentication is temporarily unavailable. Try again later. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: unavailable: value: _meta: success: false statusCode: 503 errorCode: '010366' messages: - >- Multi-factor authentication is temporarily unavailable. Try again later. content: null security: - mfaChallenge: [] mfaBinding: [] summary: Read the browser-bound MFA request. tags: - Authentication /v1/auth/mfa/status: get: description: >- Returns deployment enforcement, account enrollment, local-password availability and remaining recovery-code count. With MFA enabled, use a verified native session or native bearer token; API keys and external credentials cannot manage MFA. With MFA disabled, this endpoint reports enabled=false for an authenticated account. operationId: AuthMfaController_status parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: additionalProperties: false description: >- MFA availability and enrollment state for the authenticated account. type: object properties: enabled: description: >- Whether this deployment enforces MFA. The backend is authoritative. example: true type: boolean enrolled: description: >- Whether the current account has a confirmed authenticator, independently of the deployment flag. example: true type: boolean hasPassword: description: >- Whether the account has a local password. MFA does not create a password for SSO-only accounts. example: true type: boolean recoveryCodesRemaining: minimum: 0 maximum: 10 description: >- Unused recovery codes remaining. Codes themselves are never returned here. example: 10 type: integer required: - enabled - enrolled - hasPassword - recoveryCodesRemaining required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: enabled: true enrolled: true hasPassword: true recoveryCodesRemaining: 10 '401': description: >- Sign in and complete multi-factor authentication first. Your authentication request expired or is no longer valid. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: not_verified: value: _meta: success: false statusCode: 401 errorCode: '010365' messages: - Sign in and complete multi-factor authentication first. content: null invalid_challenge: value: _meta: success: false statusCode: 401 errorCode: '010361' messages: - >- Your authentication request expired or is no longer valid. Start again. content: null '503': description: >- Multi-factor authentication is temporarily unavailable. Try again later. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: unavailable: value: _meta: success: false statusCode: 503 errorCode: '010366' messages: - >- Multi-factor authentication is temporarily unavailable. Try again later. content: null security: - bearer: [] - cookie: [] summary: Read the current account's MFA status. tags: - Authentication /v1/auth/mfa/verify: post: description: >- Use totp or a single-use recovery code in the verify stage. A valid proof advances to verified without issuing native credentials; call complete next. support_recovery only continues a challenge already authorized by the verified manual recovery procedure. Keep both challenge cookies and, for management challenges, the initiating native credential. MFA must be enabled. operationId: AuthMfaController_verify parameters: [] requestBody: required: true content: application/json: schema: description: >- Verify an existing factor, consume one recovery code, or continue an already authorized support-recovery challenge. anyOf: - additionalProperties: false type: object properties: method: const: totp type: string code: pattern: ^[0-9]{6}$ minLength: 6 maxLength: 6 description: >- Current six-digit authenticator code. Send a string to preserve leading zeroes. example: '012345' type: string required: - method - code - additionalProperties: false type: object properties: method: const: recovery type: string code: minLength: 32 maxLength: 64 description: >- A single-use recovery code: 32 hexadecimal digits, optionally separated by spaces or hyphens. Case-insensitive. example: AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-1111 type: string required: - method - code - additionalProperties: false description: >- Continue a recovery_authorized challenge after verified manual support recovery. This method cannot authorize recovery itself. type: object properties: method: const: support_recovery type: string required: - method examples: authenticator: value: method: totp code: '012345' recoveryCode: value: method: recovery code: AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-1111 authorizedSupportRecovery: value: method: support_recovery description: Request payload for Verify an existing MFA factor. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - additionalProperties: false description: >- Existing factor verified; complete the login to obtain native credentials. type: object properties: purpose: description: Operation bound to this challenge. example: login anyOf: - const: login type: string - const: factor_replace type: string - const: recovery_regenerate type: string expiresAt: description: >- Fixed challenge expiration as Unix milliseconds. Reading or replaying the challenge does not extend it. example: 1791673500000 type: number email: description: Masked account email. example: t***@example.test type: string returnPath: description: Validated platform path to use after completion. example: /dashboard type: string recoveryReference: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Challenge identifier used to match a verified manual recovery request. stage: const: verified type: string required: - purpose - expiresAt - email - returnPath - recoveryReference - stage - additionalProperties: false description: >- Authorized recovery now requires new authenticator enrollment. type: object properties: purpose: description: Operation bound to this challenge. example: login anyOf: - const: login type: string - const: factor_replace type: string - const: recovery_regenerate type: string expiresAt: description: >- Fixed challenge expiration as Unix milliseconds. Reading or replaying the challenge does not extend it. example: 1791673500000 type: number email: description: Masked account email. example: t***@example.test type: string returnPath: description: Validated platform path to use after completion. example: /dashboard type: string recoveryReference: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Challenge identifier used to match a verified manual recovery request. stage: const: recover_enroll type: string manualKey: description: >- Base32 setup secret, returned only during enrollment. The example is a public test secret. example: GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ type: string accountLabel: description: Account label displayed by the authenticator. example: Minespider:test@example.test type: string provisioningUri: description: >- Standard otpauth URI to render as a QR code. The example uses a public test secret. example: >- otpauth://totp/Minespider%3Atest%40example.test?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=Minespider&algorithm=SHA1&digits=6&period=30 type: string required: - purpose - expiresAt - email - returnPath - recoveryReference - stage - manualKey - accountLabel - provisioningUri required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: purpose: login expiresAt: 1791673500000 email: t***@example.test returnPath: /dashboard recoveryReference: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f stage: verified '400': description: >- Invalid request body: extra fields, invalid types or more than 2048 bytes are rejected. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: >- Your authentication request expired or is no longer valid. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: invalid_challenge: value: _meta: success: false statusCode: 401 errorCode: '010361' messages: - >- Your authentication request expired or is no longer valid. Start again. content: null '403': description: This authentication request cannot perform that action. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: forbidden: value: _meta: success: false statusCode: 403 errorCode: '010367' messages: - This authentication request cannot perform that action. content: null '409': description: >- This authentication code has already been used. Wait for the next code. Your account security changed. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: reused_code: value: _meta: success: false statusCode: 409 errorCode: '010360' messages: - >- This authentication code has already been used. Wait for the next code. content: null conflict: value: _meta: success: false statusCode: 409 errorCode: '010363' messages: - Your account security changed. Start again. content: null '422': description: >- Enter a valid six-digit authentication code. This recovery code is invalid or has already been used. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: invalid_code: value: _meta: success: false statusCode: 422 errorCode: '010359' messages: - Enter a valid six-digit authentication code. content: null invalid_recovery: value: _meta: success: false statusCode: 422 errorCode: '010364' messages: - This recovery code is invalid or has already been used. content: null '429': description: Too many authentication attempts. Try again later. headers: Retry-After: description: Seconds before another authentication attempt is allowed. schema: type: integer minimum: 1 example: 300 content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: attempts: value: _meta: success: false statusCode: 429 errorCode: '010362' messages: - Too many authentication attempts. Try again later. content: null '503': description: >- Multi-factor authentication is temporarily unavailable. Try again later. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: unavailable: value: _meta: success: false statusCode: 503 errorCode: '010366' messages: - >- Multi-factor authentication is temporarily unavailable. Try again later. content: null security: - mfaChallenge: [] mfaBinding: [] summary: Verify an existing MFA factor. tags: - Authentication /v1/auth/mfa/enrollment/confirm: post: description: >- Allowed in enroll or recover_enroll with both challenge cookies. Returns ten recovery codes in save_codes; the new factor and native credentials are not activated until complete receives explicit save acknowledgment. MFA must be enabled. operationId: AuthMfaController_confirm parameters: [] requestBody: required: true content: application/json: schema: additionalProperties: false description: >- Confirm the authenticator generated by the current enrollment challenge. type: object properties: code: pattern: ^[0-9]{6}$ minLength: 6 maxLength: 6 description: >- Current six-digit authenticator code. Send a string to preserve leading zeroes. example: '012345' type: string required: - code example: code: '012345' description: Request payload for Confirm the new authenticator. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: additionalProperties: false description: >- Codes are returned only while the challenge is in save_codes; no setup secret is returned in this stage. type: object properties: purpose: description: Operation bound to this challenge. example: login anyOf: - const: login type: string - const: factor_replace type: string - const: recovery_regenerate type: string expiresAt: description: >- Fixed challenge expiration as Unix milliseconds. Reading or replaying the challenge does not extend it. example: 1791673500000 type: number email: description: Masked account email. example: t***@example.test type: string returnPath: description: Validated platform path to use after completion. example: /dashboard type: string recoveryReference: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Challenge identifier used to match a verified manual recovery request. stage: description: New codes await explicit save acknowledgment. const: save_codes type: string recoveryCodes: minItems: 10 maxItems: 10 uniqueItems: true description: >- Ten single-use recovery codes. Store them before completing. Regenerated codes replace the old set only after completion. example: - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0001 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0002 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0003 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0004 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0005 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0006 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0007 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0008 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0009 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-000A type: array items: pattern: ^[A-F0-9]{4}(-[A-F0-9]{4}){7}$ type: string required: - purpose - expiresAt - email - returnPath - recoveryReference - stage - recoveryCodes required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: purpose: login expiresAt: 1791673500000 email: t***@example.test returnPath: /dashboard recoveryReference: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f stage: save_codes recoveryCodes: - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0001 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0002 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0003 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0004 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0005 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0006 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0007 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0008 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0009 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-000A '400': description: >- Invalid request body: extra fields, invalid types or more than 2048 bytes are rejected. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: >- Your authentication request expired or is no longer valid. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: invalid_challenge: value: _meta: success: false statusCode: 401 errorCode: '010361' messages: - >- Your authentication request expired or is no longer valid. Start again. content: null '403': description: This authentication request cannot perform that action. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: forbidden: value: _meta: success: false statusCode: 403 errorCode: '010367' messages: - This authentication request cannot perform that action. content: null '409': description: Your account security changed. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: conflict: value: _meta: success: false statusCode: 409 errorCode: '010363' messages: - Your account security changed. Start again. content: null '422': description: Enter a valid six-digit authentication code. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: invalid_code: value: _meta: success: false statusCode: 422 errorCode: '010359' messages: - Enter a valid six-digit authentication code. content: null '429': description: Too many authentication attempts. Try again later. headers: Retry-After: description: Seconds before another authentication attempt is allowed. schema: type: integer minimum: 1 example: 300 content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: attempts: value: _meta: success: false statusCode: 429 errorCode: '010362' messages: - Too many authentication attempts. Try again later. content: null '503': description: >- Multi-factor authentication is temporarily unavailable. Try again later. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: unavailable: value: _meta: success: false statusCode: 503 errorCode: '010366' messages: - >- Multi-factor authentication is temporarily unavailable. Try again later. content: null security: - mfaChallenge: [] mfaBinding: [] summary: Confirm the new authenticator. tags: - Authentication /v1/auth/mfa/complete: post: description: >- Keep both challenge cookies and use the required Idempotency-Key. save_codes requires savedCodesAcknowledged=true. Login and authenticator replacement issue native credentials and set the session cookie; replacement revokes other native sessions. Recovery-code regeneration retains the current session and returns no tokens. Retry with the same key and acknowledgment only within the original challenge deadline. Management challenges require the initiating native credential. MFA must be enabled. operationId: AuthMfaController_complete parameters: - name: Idempotency-Key in: header description: >- A single 1–128 character printable ASCII key without whitespace. Reuse the same key and acknowledgment to replay this completion within the original five-minute deadline. required: true schema: type: string minLength: 1 maxLength: 128 pattern: ^[!-~]{1,128}$ example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false description: >- Complete the browser-bound challenge using the required Idempotency-Key header. type: object properties: savedCodesAcknowledged: description: >- Must be true in save_codes after storing the displayed recovery codes. A verified login without new recovery codes may send false. example: true type: boolean required: - savedCodesAcknowledged example: savedCodesAcknowledged: true description: Request payload for Complete the MFA request. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- Completion receipt. The same key, acknowledgment and bound browser can replay it within the original five-minute deadline. anyOf: - additionalProperties: false description: >- Login or authenticator-replacement completion. Native credentials are returned and the session cookie is set. type: object properties: userId: allOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Account that completed the MFA challenge. accessToken: minLength: 1 description: >- Native access JWT issued after MFA. Its length depends on the account payload and signing key. example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c type: string expiresIn: description: Access token lifetime in seconds. example: 3600 type: number refreshToken: minLength: 1 maxLength: 700 description: >- Opaque native refresh token for the existing access-token renewal endpoint. example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c type: string refreshTokenExpiresAt: description: Refresh-token expiration as Unix milliseconds. example: 1791759600000 type: number returnPath: description: Validated destination after completion. example: /dashboard type: string recoveryUsed: description: >- Whether this login used a recovery code, allowing the bounded replacement flow. example: false type: boolean required: - userId - accessToken - expiresIn - refreshToken - refreshTokenExpiresAt - returnPath - recoveryUsed - additionalProperties: false description: >- Recovery-code regeneration completion. The current native session remains in use; no new tokens are returned. type: object properties: userId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Account that completed the MFA challenge. returnPath: description: Validated destination after completion. example: /dashboard type: string recoveryUsed: description: >- Whether this login used a recovery code, allowing the bounded replacement flow. example: false type: boolean required: - userId - returnPath - recoveryUsed required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: userId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f returnPath: /dashboard recoveryUsed: false '400': description: >- Invalid request body: extra fields, invalid types or more than 2048 bytes are rejected. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: >- Your authentication request expired or is no longer valid. Start again. Sign in and complete multi-factor authentication first. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: invalid_challenge: value: _meta: success: false statusCode: 401 errorCode: '010361' messages: - >- Your authentication request expired or is no longer valid. Start again. content: null not_verified: value: _meta: success: false statusCode: 401 errorCode: '010365' messages: - Sign in and complete multi-factor authentication first. content: null '403': description: This authentication request cannot perform that action. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: forbidden: value: _meta: success: false statusCode: 403 errorCode: '010367' messages: - This authentication request cannot perform that action. content: null '409': description: Your account security changed. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: conflict: value: _meta: success: false statusCode: 409 errorCode: '010363' messages: - Your account security changed. Start again. content: null '503': description: >- Multi-factor authentication is temporarily unavailable. Try again later. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: unavailable: value: _meta: success: false statusCode: 503 errorCode: '010366' messages: - >- Multi-factor authentication is temporarily unavailable. Try again later. content: null security: - mfaChallenge: [] mfaBinding: [] summary: Complete the MFA request. tags: - Authentication /v1/auth/mfa/cancel: post: description: >- Requires both challenge cookies; management challenges also require the initiating native credential. Cancels the pending request and clears its cookies. Uncompleted replacement or regeneration preserves the existing authenticator and known recovery codes. MFA must be enabled. operationId: AuthMfaController_cancel parameters: [] requestBody: required: true content: application/json: schema: additionalProperties: false description: >- Send an empty JSON object. Identity and authority come from the challenge cookies. type: object properties: {} example: {} description: Request payload for Cancel the current MFA request. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: additionalProperties: false type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: {} '400': description: >- Invalid request body: extra fields, invalid types or more than 2048 bytes are rejected. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: >- Your authentication request expired or is no longer valid. Start again. Sign in and complete multi-factor authentication first. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: invalid_challenge: value: _meta: success: false statusCode: 401 errorCode: '010361' messages: - >- Your authentication request expired or is no longer valid. Start again. content: null not_verified: value: _meta: success: false statusCode: 401 errorCode: '010365' messages: - Sign in and complete multi-factor authentication first. content: null '403': description: This authentication request cannot perform that action. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: forbidden: value: _meta: success: false statusCode: 403 errorCode: '010367' messages: - This authentication request cannot perform that action. content: null '409': description: Your account security changed. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: conflict: value: _meta: success: false statusCode: 409 errorCode: '010363' messages: - Your account security changed. Start again. content: null '503': description: >- Multi-factor authentication is temporarily unavailable. Try again later. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: unavailable: value: _meta: success: false statusCode: 503 errorCode: '010366' messages: - >- Multi-factor authentication is temporarily unavailable. Try again later. content: null security: - mfaChallenge: [] mfaBinding: [] summary: Cancel the current MFA request. tags: - Authentication /v1/auth/mfa/manage/start: post: description: >- Requires a verified native session or native bearer token. Use TOTP to authorize replacement or regeneration. Recovery codes, or the same login's unconsumed recovery proof using its issued native session or bearer token, authorize authenticator replacement only. Returns /mfa and sets the two challenge cookies; keep them alongside the initiating native credential. No factor or recovery-code set is replaced at this step. MFA must be enabled. operationId: AuthMfaController_manage parameters: [] requestBody: required: true content: application/json: schema: description: >- Authorize authenticator replacement or recovery-code regeneration. Regeneration requires TOTP; recovery methods authorize replacement only. anyOf: - additionalProperties: false type: object properties: purpose: description: The account-security operation to authorize. anyOf: - const: factor_replace type: string - const: recovery_regenerate type: string method: const: totp type: string code: pattern: ^[0-9]{6}$ minLength: 6 maxLength: 6 description: >- Current six-digit authenticator code. Send a string to preserve leading zeroes. example: '012345' type: string required: - purpose - method - code - additionalProperties: false type: object properties: purpose: const: factor_replace type: string method: const: recovery type: string code: minLength: 32 maxLength: 64 description: >- A single-use recovery code: 32 hexadecimal digits, optionally separated by spaces or hyphens. Case-insensitive. example: AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-1111 type: string required: - purpose - method - code - additionalProperties: false description: >- Reuse the same login's unexpired, unconsumed recovery proof using its issued native session or bearer token for authenticator replacement. type: object properties: purpose: const: factor_replace type: string method: const: recovery_login type: string required: - purpose - method examples: replaceAuthenticator: value: purpose: factor_replace method: totp code: '012345' regenerateCodes: value: purpose: recovery_regenerate method: totp code: '012345' replaceWithRecoveryCode: value: purpose: factor_replace method: recovery code: AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-1111 replaceAfterRecoveryLogin: value: purpose: factor_replace method: recovery_login description: Request payload for Start an account MFA management request. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: nextPath: description: Frontend route for completing MFA. example: /mfa const: /mfa type: string required: - nextPath required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: nextPath: /mfa '400': description: >- Invalid request body: extra fields, invalid types or more than 2048 bytes are rejected. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: >- Sign in and complete multi-factor authentication first. Your authentication request expired or is no longer valid. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: not_verified: value: _meta: success: false statusCode: 401 errorCode: '010365' messages: - Sign in and complete multi-factor authentication first. content: null invalid_challenge: value: _meta: success: false statusCode: 401 errorCode: '010361' messages: - >- Your authentication request expired or is no longer valid. Start again. content: null '403': description: This authentication request cannot perform that action. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: forbidden: value: _meta: success: false statusCode: 403 errorCode: '010367' messages: - This authentication request cannot perform that action. content: null '409': description: >- This authentication code has already been used. Wait for the next code. Your account security changed. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: reused_code: value: _meta: success: false statusCode: 409 errorCode: '010360' messages: - >- This authentication code has already been used. Wait for the next code. content: null conflict: value: _meta: success: false statusCode: 409 errorCode: '010363' messages: - Your account security changed. Start again. content: null '422': description: >- Enter a valid six-digit authentication code. This recovery code is invalid or has already been used. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: invalid_code: value: _meta: success: false statusCode: 422 errorCode: '010359' messages: - Enter a valid six-digit authentication code. content: null invalid_recovery: value: _meta: success: false statusCode: 422 errorCode: '010364' messages: - This recovery code is invalid or has already been used. content: null '429': description: Too many authentication attempts. Try again later. headers: Retry-After: description: Seconds before another authentication attempt is allowed. schema: type: integer minimum: 1 example: 300 content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: attempts: value: _meta: success: false statusCode: 429 errorCode: '010362' messages: - Too many authentication attempts. Try again later. content: null '503': description: >- Multi-factor authentication is temporarily unavailable. Try again later. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: unavailable: value: _meta: success: false statusCode: 503 errorCode: '010366' messages: - >- Multi-factor authentication is temporarily unavailable. Try again later. content: null security: - bearer: [] - cookie: [] summary: Start an account MFA management request. tags: - Authentication /v1/auth/mfa/recovery-codes/regenerate: post: description: >- Requires both challenge cookies from a recovery_regenerate management request in action_authorized and its initiating native credential. Returns ten pending codes in save_codes. Existing codes stay valid until complete receives savedCodesAcknowledged=true; cancelling or expiration preserves the old codes. MFA must be enabled. operationId: AuthMfaController_regenerate parameters: [] requestBody: required: true content: application/json: schema: additionalProperties: false description: >- Send an empty JSON object. Identity and authority come from the challenge cookies. type: object properties: {} example: {} description: Request payload for Prepare new recovery codes. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: additionalProperties: false description: >- Pending regenerated codes; complete with explicit save acknowledgment to replace the old set. type: object properties: purpose: const: recovery_regenerate type: string expiresAt: description: >- Fixed challenge expiration as Unix milliseconds. Reading or replaying the challenge does not extend it. example: 1791673500000 type: number email: description: Masked account email. example: t***@example.test type: string returnPath: description: Validated platform path to use after completion. example: /dashboard type: string recoveryReference: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Challenge identifier used to match a verified manual recovery request. stage: description: New codes await explicit save acknowledgment. const: save_codes type: string recoveryCodes: minItems: 10 maxItems: 10 uniqueItems: true description: >- Ten single-use recovery codes. Store them before completing. Regenerated codes replace the old set only after completion. example: - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0001 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0002 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0003 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0004 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0005 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0006 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0007 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0008 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0009 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-000A type: array items: pattern: ^[A-F0-9]{4}(-[A-F0-9]{4}){7}$ type: string required: - purpose - expiresAt - email - returnPath - recoveryReference - stage - recoveryCodes required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: purpose: recovery_regenerate expiresAt: 1791673500000 email: t***@example.test returnPath: /dashboard recoveryReference: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f stage: save_codes recoveryCodes: - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0001 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0002 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0003 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0004 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0005 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0006 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0007 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0008 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-0009 - AAAA-BBBB-CCCC-DDDD-EEEE-FFFF-0000-000A '400': description: >- Invalid request body: extra fields, invalid types or more than 2048 bytes are rejected. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: >- Your authentication request expired or is no longer valid. Start again. Sign in and complete multi-factor authentication first. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: invalid_challenge: value: _meta: success: false statusCode: 401 errorCode: '010361' messages: - >- Your authentication request expired or is no longer valid. Start again. content: null not_verified: value: _meta: success: false statusCode: 401 errorCode: '010365' messages: - Sign in and complete multi-factor authentication first. content: null '403': description: This authentication request cannot perform that action. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: forbidden: value: _meta: success: false statusCode: 403 errorCode: '010367' messages: - This authentication request cannot perform that action. content: null '409': description: Your account security changed. Start again. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: conflict: value: _meta: success: false statusCode: 409 errorCode: '010363' messages: - Your account security changed. Start again. content: null '503': description: >- Multi-factor authentication is temporarily unavailable. Try again later. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' examples: unavailable: value: _meta: success: false statusCode: 503 errorCode: '010366' messages: - >- Multi-factor authentication is temporarily unavailable. Try again later. content: null security: - mfaChallenge: [] mfaBinding: [] summary: Prepare new recovery codes. tags: - Authentication /v1/auth/users/me: get: description: Retrieves profile data of the currently authenticated user. operationId: UserController_me parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: User type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID firstName: description: User first name example: John type: string lastName: description: User last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string emailVerified: default: false description: Whether user email verified or not example: true type: boolean emailVerifiedAt: description: Timestamp of email verification date example: 1686042132022 type: number admin: default: false description: Whether user is admin or not example: true type: boolean active: default: false description: Whether user is active or not example: true type: boolean activatedAt: description: Timestamp of user account activation date example: 1686042132022 type: number lastLogin: description: Timestamp of user last login date example: 1686042132022 type: number resetPasswordNextLogin: default: false description: >- Whether the user must update its password on next login example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - emailVerified - admin - active - resetPasswordNextLogin - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com emailVerified: true admin: true active: true resetPasswordNextLogin: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get current user information. tags: - Users /v1/auth/users/{id}: get: description: >- Fetches detailed information of a specific user identified by their UUID. operationId: UserController_findOne parameters: - name: id required: true in: path description: User UUID schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: User type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID firstName: description: User first name example: John type: string lastName: description: User last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string emailVerified: default: false description: Whether user email verified or not example: true type: boolean emailVerifiedAt: description: Timestamp of email verification date example: 1686042132022 type: number admin: default: false description: Whether user is admin or not example: true type: boolean active: default: false description: Whether user is active or not example: true type: boolean activatedAt: description: Timestamp of user account activation date example: 1686042132022 type: number lastLogin: description: Timestamp of user last login date example: 1686042132022 type: number resetPasswordNextLogin: default: false description: >- Whether the user must update its password on next login example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - emailVerified - admin - active - resetPasswordNextLogin - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com emailVerified: true admin: true active: true resetPasswordNextLogin: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve user by ID. tags: - Users /v1/auth/users: get: description: >- Fetches the list of users in the system. This route is restricted to the root user only. operationId: UserController_find parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: User type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID firstName: description: User first name example: John type: string lastName: description: User last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string emailVerified: default: false description: Whether user email verified or not example: true type: boolean emailVerifiedAt: description: Timestamp of email verification date example: 1686042132022 type: number admin: default: false description: Whether user is admin or not example: true type: boolean active: default: false description: Whether user is active or not example: true type: boolean activatedAt: description: Timestamp of user account activation date example: 1686042132022 type: number lastLogin: description: Timestamp of user last login date example: 1686042132022 type: number resetPasswordNextLogin: default: false description: >- Whether the user must update its password on next login example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - emailVerified - admin - active - resetPasswordNextLogin - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com emailVerified: true admin: true active: true resetPasswordNextLogin: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve the collection of Users. Only accessible for root user. tags: - Users /v1/auth/users/{id}/activate: post: description: >- Activates a previously inactive user. This action is restricted to the root user only. operationId: UserController_activate parameters: - name: id required: true in: path description: User UUID schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Activate an inactive User. Only accessible for root user. tags: - Users /v1/auth/users/{id}/deactivate-password: get: description: >- Deactivates a user's password, allowing them to continue logging in with the current password. However, every API request will prompt the user to change their password. operationId: UserController_deactivatePassword parameters: - name: id required: true in: path description: User UUID schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Deactivate a User's password. Only accessible for root user. tags: - Users /v1/auth/api-token: get: description: >- Fetches a list of all API tokens associated with the system, including their status and metadata. operationId: ApiTokenController_getApiTokens parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Api token type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Api token UUID token: description: Api token type: string userId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID description: description: Description of api token type: string active: default: true description: Whether token active or not example: true type: boolean createdAt: description: When token was created example: 1696426714485 type: integer updatedAt: description: When token was updated example: 1686042132022 type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Creator user UUID updatedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Editor user UUID required: - id - token - userId - description - active - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f token: opaque-token userId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: description active: true createdAt: 1696426714485 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve all API tokens. tags: - API Tokens post: description: Generates a new API token for the user, providing access to the system. operationId: ApiTokenController_createApiToken parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Authentication login body schema type: object properties: email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string password: minLength: 1 maxLength: 255 description: User password example: SuperSecret! type: string mfaCode: pattern: ^[0-9]{6}$ minLength: 6 maxLength: 6 description: >- Current six-digit authenticator code. Required when MFA is enabled, after password confirmation and enrollment. Send a string to preserve leading zeroes; recovery codes are not accepted for API-key creation. example: '012345' type: string description: description: Description of api token type: string required: - email - password - description example: email: john@mail.com password: SuperSecret! mfaCode: '012345' description: description description: Request payload for Create a new API token. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Api token type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Api token UUID token: description: Api token type: string userId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID description: description: Description of api token type: string active: default: true description: Whether token active or not example: true type: boolean createdAt: description: When token was created example: 1696426714485 type: integer updatedAt: description: When token was updated example: 1686042132022 type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Creator user UUID updatedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Editor user UUID required: - id - token - userId - description - active - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f token: opaque-token userId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: description active: true createdAt: 1696426714485 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a new API token. tags: - API Tokens /v1/auth/api-token/{tokenId}: get: description: Fetches the API token associated with the provided ID. operationId: ApiTokenController_getApiToken parameters: - name: tokenId required: true in: path schema: type: string description: Token identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Api token type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Api token UUID token: description: Api token type: string userId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID description: description: Description of api token type: string active: default: true description: Whether token active or not example: true type: boolean createdAt: description: When token was created example: 1696426714485 type: integer updatedAt: description: When token was updated example: 1686042132022 type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Creator user UUID updatedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Editor user UUID required: - id - token - userId - description - active - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f token: opaque-token userId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: description active: true createdAt: 1696426714485 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve API token by ID. tags: - API Tokens patch: description: >- Changes the status of the specified API token, either activating or deactivating it. operationId: ApiTokenController_updateApiToken parameters: - name: tokenId required: true in: path schema: type: string description: Token identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: minProperties: 1 description: Update api token body schema type: object properties: active: description: Whether token active or not example: true type: boolean description: description: Description of api token type: string example: active: true description: description description: Request payload for Activate or deactivate an API token. responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Activate or deactivate an API token. tags: - API Tokens delete: description: Removes the API token associated with the provided ID from the system. operationId: ApiTokenController_delete parameters: - name: tokenId required: true in: path schema: type: string description: Token identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete an API token by ID. tags: - API Tokens /v1/entity/types: post: description: >- Allows root entity members to create a new entity type within the platform. operationId: EntityTypeController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create new entity type. tags: - Entity Types get: description: Fetches a list of all available entity types in the system. operationId: EntityTypeController_getMany parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true - name: order required: false in: query schema: default: name type: string description: Result ordering expression. example: name - name: createdBy required: false in: query schema: type: string description: Created by value used by this operation. example: created-by responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get entity types. tags: - Entity Types /v1/entity/types/{id}: get: description: >- Retrieves detailed information of a specific entity type by its unique identifier. operationId: EntityTypeController_get parameters: - name: id required: true in: path schema: type: string description: Type identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get entity type by ID. tags: - Entity Types patch: description: >- Updates the details of an existing entity type. This action is only accessible to root entity members. operationId: EntityTypeController_update parameters: - name: id required: true in: path schema: type: string description: Type identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Edit entity type. tags: - Entity Types delete: description: >- Deletes a specific entity type from the platform. This action is only accessible to root entity members. operationId: EntityTypeController_remove parameters: - name: id required: true in: path schema: type: string description: Type identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Remove entity type. tags: - Entity Types /v1/entity/entities/{entityId}/invitations: post: description: >- Generates a new invitation for an entity to join or participate in the system. operationId: InvitationController_create parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create invitation body schema type: object properties: firstName: minLength: 1 maxLength: 255 type: string lastName: minLength: 1 maxLength: 255 type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string required: - firstName - lastName - email example: firstName: first-name lastName: last-name email: john@mail.com description: Request payload for Create an invitation. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Invitation type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Invitation UUID firstName: description: Invitee first name example: John type: string lastName: description: Invitee last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string invitee: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy inviter: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy expirationDate: description: Timestamp of invitation expiration date example: 1686042132022 type: number status: description: >- Condition of the invitation. Possible values: open, denied, accepted example: open anyOf: - const: open type: string - const: denied type: string - const: accepted type: string respondedAt: description: Timestamp of invitee response date example: 1686042132022 type: number createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - invitee - inviter - expirationDate - status - respondedAt - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com invitee: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f inviter: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f expirationDate: 1686042132022 status: open respondedAt: 1686042132022 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create an invitation. tags: - Invitations get: description: >- Fetches a collection of invitations based on the specified criteria or filters. operationId: InvitationController_get parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: status required: false in: query schema: type: string description: Filter by lifecycle status. example: published - name: expired required: false in: query schema: type: boolean description: Expired value used by this operation. example: true - name: scope required: false in: query schema: default: external anyOf: - const: internal type: string - const: external type: string - const: all type: string description: Scope value used by this operation. example: external - name: createdAt required: false in: query schema: type: string description: Filter by creation timestamp. example: created-at - name: createdBy required: false in: query schema: type: string description: Created by value used by this operation. example: created-by - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Invitation type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Invitation UUID firstName: description: Invitee first name example: John type: string lastName: description: Invitee last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string invitee: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy inviter: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy expirationDate: description: Timestamp of invitation expiration date example: 1686042132022 type: number status: description: >- Condition of the invitation. Possible values: open, denied, accepted example: open anyOf: - const: open type: string - const: denied type: string - const: accepted type: string respondedAt: description: Timestamp of invitee response date example: 1686042132022 type: number createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - invitee - inviter - expirationDate - status - respondedAt - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com invitee: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f inviter: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f expirationDate: 1686042132022 status: open respondedAt: 1686042132022 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve multiple invitations. tags: - Invitations /v1/entity/entities/{entityId}/invitations/{id}: patch: description: >- Modifies the details of an existing invitation, such as expiration date or recipient information. operationId: InvitationController_update parameters: - name: id required: true in: path schema: type: string description: Invitation identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Update invitation body schema type: object properties: email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string required: - email example: email: john@mail.com description: Request payload for Update an invitation. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Invitation type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Invitation UUID firstName: description: Invitee first name example: John type: string lastName: description: Invitee last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string invitee: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy inviter: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy expirationDate: description: Timestamp of invitation expiration date example: 1686042132022 type: number status: description: >- Condition of the invitation. Possible values: open, denied, accepted example: open anyOf: - const: open type: string - const: denied type: string - const: accepted type: string respondedAt: description: Timestamp of invitee response date example: 1686042132022 type: number createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - invitee - inviter - expirationDate - status - respondedAt - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com invitee: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f inviter: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f expirationDate: 1686042132022 status: open respondedAt: 1686042132022 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Update an invitation. tags: - Invitations delete: description: >- Removes the specified invitation from the system, preventing further use or acceptance. operationId: InvitationController_remove parameters: - name: id required: true in: path schema: type: string description: Invitation identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete an invitation. tags: - Invitations get: description: Fetches the details of a specific invitation based on the provided ID. operationId: InvitationController_getOne parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: id required: true in: path schema: type: string description: Invitation identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Invitation type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Invitation UUID firstName: description: Invitee first name example: John type: string lastName: description: Invitee last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string invitee: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy inviter: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy expirationDate: description: Timestamp of invitation expiration date example: 1686042132022 type: number status: description: >- Condition of the invitation. Possible values: open, denied, accepted example: open anyOf: - const: open type: string - const: denied type: string - const: accepted type: string respondedAt: description: Timestamp of invitee response date example: 1686042132022 type: number createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - invitee - inviter - expirationDate - status - respondedAt - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com invitee: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f inviter: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f expirationDate: 1686042132022 status: open respondedAt: 1686042132022 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: - {} - bearer: [] - cookie: [] summary: Retrieve invitation by ID. tags: - Invitations /v1/entity/entities/{entityId}/invitations/{id}/denial: post: description: >- Rejects the specified invitation, preventing the entity from joining or participating in the system. operationId: InvitationController_deny parameters: - name: id required: true in: path schema: type: string description: Invitation identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Deny an invitation. tags: - Invitations /v1/entity/entities/{entityId}/invitations/{id}/renewal: post: description: >- Extends the validity of an existing invitation, allowing the entity more time to accept it. operationId: InvitationController_renew parameters: - name: id required: true in: path schema: type: string description: Invitation identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Renew an invitation. tags: - Invitations /v1/entity/entities/{id}/approval: post: description: >- Marks the specified entity as approved, granting it the necessary permissions or status. operationId: EntityController_approve parameters: - name: id required: true in: path description: Entity UUID schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Approve an entity. tags: - Entities /v1/entity/entities/{id}: get: description: Fetches the details of an entity based on the provided ID. operationId: EntityController_get parameters: - name: id required: true in: path description: Entity UUID schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: [] summary: Retrieve entity by ID. tags: - Entities delete: description: Deletes the specified entity from the system. operationId: EntityController_remove parameters: - name: id required: true in: path description: Entity UUID schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Remove an entity. tags: - Entities patch: description: Modifies the details of an existing entity in the system. operationId: EntityController_update parameters: - name: id required: true in: path description: Entity UUID schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: name: minLength: 3 maxLength: 255 description: Entity name example: Minespider Germany GmbH type: string type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID required: - id email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string avatar: anyOf: - pattern: ^https?://\S+$ description: >- Avatar of the entity to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 type: string - type: 'null' about: description: Entity about information example: We enable you to be at the cutting-edge of sustainability. type: string cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - minLength: 3 maxLength: 255 type: string - type: 'null' city: description: The city's name where an entity is located officially example: Berlin anyOf: - minLength: 3 maxLength: 255 type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - anyOf: - const: AD type: string - const: ad type: string - const: AF type: string - const: af type: string - const: AG type: string - const: ag type: string - const: AI type: string - const: ai type: string - const: AL type: string - const: al type: string - const: AM type: string - const: am type: string - const: AO type: string - const: ao type: string - const: AQ type: string - const: aq type: string - const: AR type: string - const: ar type: string - const: AS type: string - const: as type: string - const: AT type: string - const: at type: string - const: AU type: string - const: au type: string - const: AW type: string - const: aw type: string - const: AX type: string - const: ax type: string - const: AZ type: string - const: az type: string - const: BA type: string - const: ba type: string - const: BB type: string - const: bb type: string - const: BD type: string - const: bd type: string - const: BE type: string - const: be type: string - const: BF type: string - const: bf type: string - const: BG type: string - const: bg type: string - const: BH type: string - const: bh type: string - const: BI type: string - const: bi type: string - const: BJ type: string - const: bj type: string - const: BL type: string - const: bl type: string - const: BM type: string - const: bm type: string - const: BN type: string - const: bn type: string - const: BO type: string - const: bo type: string - const: BQ type: string - const: bq type: string - const: BR type: string - const: br type: string - const: BT type: string - const: bt type: string - const: BV type: string - const: bv type: string - const: BW type: string - const: bw type: string - const: BY type: string - const: by type: string - const: BZ type: string - const: bz type: string - const: CA type: string - const: ca type: string - const: CH type: string - const: ch type: string - const: CI type: string - const: ci type: string - const: CL type: string - const: cl type: string - const: CM type: string - const: cm type: string - const: CN type: string - const: cn type: string - const: CO type: string - const: co type: string - const: CR type: string - const: cr type: string - const: CU type: string - const: cu type: string - const: CV type: string - const: cv type: string - const: CW type: string - const: cw type: string - const: CX type: string - const: cx type: string - const: CY type: string - const: cy type: string - const: DE type: string - const: de type: string - const: DJ type: string - const: dj type: string - const: DK type: string - const: dk type: string - const: DM type: string - const: dm type: string - const: DZ type: string - const: dz type: string - const: EC type: string - const: ec type: string - const: EE type: string - const: ee type: string - const: EG type: string - const: eg type: string - const: EH type: string - const: eh type: string - const: ER type: string - const: er type: string - const: ES type: string - const: es type: string - const: ET type: string - const: et type: string - const: FI type: string - const: fi type: string - const: FJ type: string - const: fj type: string - const: FM type: string - const: fm type: string - const: FR type: string - const: fr type: string - const: GA type: string - const: ga type: string - const: GD type: string - const: gd type: string - const: GE type: string - const: ge type: string - const: GF type: string - const: gf type: string - const: GG type: string - const: gg type: string - const: GH type: string - const: gh type: string - const: GI type: string - const: gi type: string - const: GL type: string - const: gl type: string - const: GN type: string - const: gn type: string - const: GP type: string - const: gp type: string - const: GQ type: string - const: gq type: string - const: GR type: string - const: gr type: string - const: GS type: string - const: gs type: string - const: GT type: string - const: gt type: string - const: GU type: string - const: gu type: string - const: GW type: string - const: gw type: string - const: GY type: string - const: gy type: string - const: HK type: string - const: hk type: string - const: HN type: string - const: hn type: string - const: HR type: string - const: hr type: string - const: HT type: string - const: ht type: string - const: HU type: string - const: hu type: string - const: ID type: string - const: id type: string - const: IE type: string - const: ie type: string - const: IL type: string - const: il type: string - const: IM type: string - const: im type: string - const: IN type: string - const: in type: string - const: IO type: string - const: io type: string - const: IQ type: string - const: iq type: string - const: IR type: string - const: ir type: string - const: IS type: string - const: is type: string - const: IT type: string - const: it type: string - const: JE type: string - const: je type: string - const: JM type: string - const: jm type: string - const: JO type: string - const: jo type: string - const: JP type: string - const: jp type: string - const: KE type: string - const: ke type: string - const: KG type: string - const: kg type: string - const: KH type: string - const: kh type: string - const: KP type: string - const: kp type: string - const: KR type: string - const: kr type: string - const: KI type: string - const: ki type: string - const: KN type: string - const: kn type: string - const: KW type: string - const: kw type: string - const: KZ type: string - const: kz type: string - const: LB type: string - const: lb type: string - const: LC type: string - const: lc type: string - const: LI type: string - const: li type: string - const: LK type: string - const: lk type: string - const: LR type: string - const: lr type: string - const: LS type: string - const: ls type: string - const: LT type: string - const: lt type: string - const: LU type: string - const: lu type: string - const: LV type: string - const: lv type: string - const: LY type: string - const: ly type: string - const: MA type: string - const: ma type: string - const: MC type: string - const: mc type: string - const: ME type: string - const: me type: string - const: MF type: string - const: mf type: string - const: MG type: string - const: mg type: string - const: ML type: string - const: ml type: string - const: MM type: string - const: mm type: string - const: MN type: string - const: mn type: string - const: MO type: string - const: mo type: string - const: MQ type: string - const: mq type: string - const: MR type: string - const: mr type: string - const: MS type: string - const: ms type: string - const: MT type: string - const: mt type: string - const: MU type: string - const: mu type: string - const: MV type: string - const: mv type: string - const: MW type: string - const: mw type: string - const: MX type: string - const: mx type: string - const: MY type: string - const: my type: string - const: MZ type: string - const: mz type: string - const: NA type: string - const: na type: string - const: NC type: string - const: nc type: string - const: NF type: string - const: nf type: string - const: NG type: string - const: ng type: string - const: NI type: string - const: ni type: string - const: 'NO' type: string - const: 'no' type: string - const: NP type: string - const: np type: string - const: NR type: string - const: nr type: string - const: NU type: string - const: nu type: string - const: NZ type: string - const: nz type: string - const: OM type: string - const: om type: string - const: PA type: string - const: pa type: string - const: PE type: string - const: pe type: string - const: PF type: string - const: pf type: string - const: PG type: string - const: pg type: string - const: PK type: string - const: pk type: string - const: PL type: string - const: pl type: string - const: PM type: string - const: pm type: string - const: PN type: string - const: pn type: string - const: PR type: string - const: pr type: string - const: PS type: string - const: ps type: string - const: PT type: string - const: pt type: string - const: PW type: string - const: pw type: string - const: PY type: string - const: py type: string - const: QA type: string - const: qa type: string - const: RE type: string - const: re type: string - const: RO type: string - const: ro type: string - const: RS type: string - const: rs type: string - const: RU type: string - const: ru type: string - const: RW type: string - const: rw type: string - const: SA type: string - const: sa type: string - const: SB type: string - const: sb type: string - const: SC type: string - const: sc type: string - const: SE type: string - const: se type: string - const: SG type: string - const: sg type: string - const: SH type: string - const: sh type: string - const: SI type: string - const: si type: string - const: SJ type: string - const: sj type: string - const: SK type: string - const: sk type: string - const: SL type: string - const: sl type: string - const: SM type: string - const: sm type: string - const: SN type: string - const: sn type: string - const: SO type: string - const: so type: string - const: SR type: string - const: sr type: string - const: SS type: string - const: ss type: string - const: ST type: string - const: st type: string - const: SV type: string - const: sv type: string - const: SX type: string - const: sx type: string - const: SY type: string - const: sy type: string - const: TD type: string - const: td type: string - const: TG type: string - const: tg type: string - const: TH type: string - const: th type: string - const: TJ type: string - const: tj type: string - const: TK type: string - const: tk type: string - const: TL type: string - const: tl type: string - const: TM type: string - const: tm type: string - const: TN type: string - const: tn type: string - const: TO type: string - const: to type: string - const: TR type: string - const: tr type: string - const: TT type: string - const: tt type: string - const: TV type: string - const: tv type: string - const: TZ type: string - const: tz type: string - const: UA type: string - const: ua type: string - const: UG type: string - const: ug type: string - const: US type: string - const: us type: string - const: UY type: string - const: uy type: string - const: UZ type: string - const: uz type: string - const: VC type: string - const: vc type: string - const: VE type: string - const: ve type: string - const: VG type: string - const: vg type: string - const: VI type: string - const: vi type: string - const: VN type: string - const: vn type: string - const: VU type: string - const: vu type: string - const: WF type: string - const: wf type: string - const: WS type: string - const: ws type: string - const: YE type: string - const: ye type: string - const: YT type: string - const: yt type: string - const: ZA type: string - const: za type: string - const: ZM type: string - const: zm type: string - const: ZW type: string - const: zw type: string - const: SZ type: string - const: sz type: string - const: MK type: string - const: mk type: string - const: PH type: string - const: ph type: string - const: NL type: string - const: nl type: string - const: AE type: string - const: ae type: string - const: MD type: string - const: md type: string - const: GM type: string - const: gm type: string - const: DO type: string - const: do type: string - const: SD type: string - const: sd type: string - const: LA type: string - const: la type: string - const: TW type: string - const: tw type: string - const: CG type: string - const: cg type: string - const: CZ type: string - const: cz type: string - const: GB type: string - const: gb type: string - const: NE type: string - const: ne type: string - const: CD type: string - const: cd type: string - const: BS type: string - const: bs type: string - const: CC type: string - const: cc type: string - const: CF type: string - const: cf type: string - const: CK type: string - const: ck type: string - const: FK type: string - const: fk type: string - const: FO type: string - const: fo type: string - const: HM type: string - const: hm type: string - const: KM type: string - const: km type: string - const: KY type: string - const: ky type: string - const: MH type: string - const: mh type: string - const: MP type: string - const: mp type: string - const: TC type: string - const: tc type: string - const: TF type: string - const: tf type: string - const: UM type: string - const: um type: string - const: VA type: string - const: va type: string - const: XK type: string - const: xk type: string - const: AN type: string - const: an type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - minLength: 1 maxLength: 6 type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - minLength: 1 maxLength: 6 type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - minLength: 3 maxLength: 20 type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: number - type: 'null' longitude: description: Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: number - type: 'null' googleMapsLink: description: A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' minProperties: 1 description: Update entity body schema example: name: Minespider Germany GmbH type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f email: john@mail.com avatar: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 about: We enable you to be at the cutting-edge of sustainability. cahraArea: false streetAddress: Dunckerstrasse 79 city: Berlin country: DE phoneCountryCode: '+49' phoneAreaCode: '30' phoneNumber: '123456' registrationNumber: '123456' latitude: 52.543304 longitude: 13.421241 googleMapsLink: https://goo.gl/maps/7XARjBaCaWoJeqEA6 description: Request payload for Edit an entity. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Edit an entity. tags: - Entities /v1/entity/entities: post: description: Adds a new entity to the system with the provided data. operationId: EntityController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create entity body schema type: object properties: name: minLength: 3 maxLength: 255 description: Entity name example: Minespider Germany GmbH type: string type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID required: - id email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string avatar: pattern: ^https?://\S+$ description: >- Avatar of the entity to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 type: string about: description: Entity about information example: We enable you to be at the cutting-edge of sustainability. type: string cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - minLength: 3 maxLength: 255 type: string - type: 'null' city: description: The city's name where an entity is located officially example: Berlin anyOf: - minLength: 3 maxLength: 255 type: string - type: 'null' country: description: The country's code where an entity is located officially example: DE anyOf: - anyOf: - const: AD type: string - const: ad type: string - const: AF type: string - const: af type: string - const: AG type: string - const: ag type: string - const: AI type: string - const: ai type: string - const: AL type: string - const: al type: string - const: AM type: string - const: am type: string - const: AO type: string - const: ao type: string - const: AQ type: string - const: aq type: string - const: AR type: string - const: ar type: string - const: AS type: string - const: as type: string - const: AT type: string - const: at type: string - const: AU type: string - const: au type: string - const: AW type: string - const: aw type: string - const: AX type: string - const: ax type: string - const: AZ type: string - const: az type: string - const: BA type: string - const: ba type: string - const: BB type: string - const: bb type: string - const: BD type: string - const: bd type: string - const: BE type: string - const: be type: string - const: BF type: string - const: bf type: string - const: BG type: string - const: bg type: string - const: BH type: string - const: bh type: string - const: BI type: string - const: bi type: string - const: BJ type: string - const: bj type: string - const: BL type: string - const: bl type: string - const: BM type: string - const: bm type: string - const: BN type: string - const: bn type: string - const: BO type: string - const: bo type: string - const: BQ type: string - const: bq type: string - const: BR type: string - const: br type: string - const: BT type: string - const: bt type: string - const: BV type: string - const: bv type: string - const: BW type: string - const: bw type: string - const: BY type: string - const: by type: string - const: BZ type: string - const: bz type: string - const: CA type: string - const: ca type: string - const: CH type: string - const: ch type: string - const: CI type: string - const: ci type: string - const: CL type: string - const: cl type: string - const: CM type: string - const: cm type: string - const: CN type: string - const: cn type: string - const: CO type: string - const: co type: string - const: CR type: string - const: cr type: string - const: CU type: string - const: cu type: string - const: CV type: string - const: cv type: string - const: CW type: string - const: cw type: string - const: CX type: string - const: cx type: string - const: CY type: string - const: cy type: string - const: DE type: string - const: de type: string - const: DJ type: string - const: dj type: string - const: DK type: string - const: dk type: string - const: DM type: string - const: dm type: string - const: DZ type: string - const: dz type: string - const: EC type: string - const: ec type: string - const: EE type: string - const: ee type: string - const: EG type: string - const: eg type: string - const: EH type: string - const: eh type: string - const: ER type: string - const: er type: string - const: ES type: string - const: es type: string - const: ET type: string - const: et type: string - const: FI type: string - const: fi type: string - const: FJ type: string - const: fj type: string - const: FM type: string - const: fm type: string - const: FR type: string - const: fr type: string - const: GA type: string - const: ga type: string - const: GD type: string - const: gd type: string - const: GE type: string - const: ge type: string - const: GF type: string - const: gf type: string - const: GG type: string - const: gg type: string - const: GH type: string - const: gh type: string - const: GI type: string - const: gi type: string - const: GL type: string - const: gl type: string - const: GN type: string - const: gn type: string - const: GP type: string - const: gp type: string - const: GQ type: string - const: gq type: string - const: GR type: string - const: gr type: string - const: GS type: string - const: gs type: string - const: GT type: string - const: gt type: string - const: GU type: string - const: gu type: string - const: GW type: string - const: gw type: string - const: GY type: string - const: gy type: string - const: HK type: string - const: hk type: string - const: HN type: string - const: hn type: string - const: HR type: string - const: hr type: string - const: HT type: string - const: ht type: string - const: HU type: string - const: hu type: string - const: ID type: string - const: id type: string - const: IE type: string - const: ie type: string - const: IL type: string - const: il type: string - const: IM type: string - const: im type: string - const: IN type: string - const: in type: string - const: IO type: string - const: io type: string - const: IQ type: string - const: iq type: string - const: IR type: string - const: ir type: string - const: IS type: string - const: is type: string - const: IT type: string - const: it type: string - const: JE type: string - const: je type: string - const: JM type: string - const: jm type: string - const: JO type: string - const: jo type: string - const: JP type: string - const: jp type: string - const: KE type: string - const: ke type: string - const: KG type: string - const: kg type: string - const: KH type: string - const: kh type: string - const: KP type: string - const: kp type: string - const: KR type: string - const: kr type: string - const: KI type: string - const: ki type: string - const: KN type: string - const: kn type: string - const: KW type: string - const: kw type: string - const: KZ type: string - const: kz type: string - const: LB type: string - const: lb type: string - const: LC type: string - const: lc type: string - const: LI type: string - const: li type: string - const: LK type: string - const: lk type: string - const: LR type: string - const: lr type: string - const: LS type: string - const: ls type: string - const: LT type: string - const: lt type: string - const: LU type: string - const: lu type: string - const: LV type: string - const: lv type: string - const: LY type: string - const: ly type: string - const: MA type: string - const: ma type: string - const: MC type: string - const: mc type: string - const: ME type: string - const: me type: string - const: MF type: string - const: mf type: string - const: MG type: string - const: mg type: string - const: ML type: string - const: ml type: string - const: MM type: string - const: mm type: string - const: MN type: string - const: mn type: string - const: MO type: string - const: mo type: string - const: MQ type: string - const: mq type: string - const: MR type: string - const: mr type: string - const: MS type: string - const: ms type: string - const: MT type: string - const: mt type: string - const: MU type: string - const: mu type: string - const: MV type: string - const: mv type: string - const: MW type: string - const: mw type: string - const: MX type: string - const: mx type: string - const: MY type: string - const: my type: string - const: MZ type: string - const: mz type: string - const: NA type: string - const: na type: string - const: NC type: string - const: nc type: string - const: NF type: string - const: nf type: string - const: NG type: string - const: ng type: string - const: NI type: string - const: ni type: string - const: 'NO' type: string - const: 'no' type: string - const: NP type: string - const: np type: string - const: NR type: string - const: nr type: string - const: NU type: string - const: nu type: string - const: NZ type: string - const: nz type: string - const: OM type: string - const: om type: string - const: PA type: string - const: pa type: string - const: PE type: string - const: pe type: string - const: PF type: string - const: pf type: string - const: PG type: string - const: pg type: string - const: PK type: string - const: pk type: string - const: PL type: string - const: pl type: string - const: PM type: string - const: pm type: string - const: PN type: string - const: pn type: string - const: PR type: string - const: pr type: string - const: PS type: string - const: ps type: string - const: PT type: string - const: pt type: string - const: PW type: string - const: pw type: string - const: PY type: string - const: py type: string - const: QA type: string - const: qa type: string - const: RE type: string - const: re type: string - const: RO type: string - const: ro type: string - const: RS type: string - const: rs type: string - const: RU type: string - const: ru type: string - const: RW type: string - const: rw type: string - const: SA type: string - const: sa type: string - const: SB type: string - const: sb type: string - const: SC type: string - const: sc type: string - const: SE type: string - const: se type: string - const: SG type: string - const: sg type: string - const: SH type: string - const: sh type: string - const: SI type: string - const: si type: string - const: SJ type: string - const: sj type: string - const: SK type: string - const: sk type: string - const: SL type: string - const: sl type: string - const: SM type: string - const: sm type: string - const: SN type: string - const: sn type: string - const: SO type: string - const: so type: string - const: SR type: string - const: sr type: string - const: SS type: string - const: ss type: string - const: ST type: string - const: st type: string - const: SV type: string - const: sv type: string - const: SX type: string - const: sx type: string - const: SY type: string - const: sy type: string - const: TD type: string - const: td type: string - const: TG type: string - const: tg type: string - const: TH type: string - const: th type: string - const: TJ type: string - const: tj type: string - const: TK type: string - const: tk type: string - const: TL type: string - const: tl type: string - const: TM type: string - const: tm type: string - const: TN type: string - const: tn type: string - const: TO type: string - const: to type: string - const: TR type: string - const: tr type: string - const: TT type: string - const: tt type: string - const: TV type: string - const: tv type: string - const: TZ type: string - const: tz type: string - const: UA type: string - const: ua type: string - const: UG type: string - const: ug type: string - const: US type: string - const: us type: string - const: UY type: string - const: uy type: string - const: UZ type: string - const: uz type: string - const: VC type: string - const: vc type: string - const: VE type: string - const: ve type: string - const: VG type: string - const: vg type: string - const: VI type: string - const: vi type: string - const: VN type: string - const: vn type: string - const: VU type: string - const: vu type: string - const: WF type: string - const: wf type: string - const: WS type: string - const: ws type: string - const: YE type: string - const: ye type: string - const: YT type: string - const: yt type: string - const: ZA type: string - const: za type: string - const: ZM type: string - const: zm type: string - const: ZW type: string - const: zw type: string - const: SZ type: string - const: sz type: string - const: MK type: string - const: mk type: string - const: PH type: string - const: ph type: string - const: NL type: string - const: nl type: string - const: AE type: string - const: ae type: string - const: MD type: string - const: md type: string - const: GM type: string - const: gm type: string - const: DO type: string - const: do type: string - const: SD type: string - const: sd type: string - const: LA type: string - const: la type: string - const: TW type: string - const: tw type: string - const: CG type: string - const: cg type: string - const: CZ type: string - const: cz type: string - const: GB type: string - const: gb type: string - const: NE type: string - const: ne type: string - const: CD type: string - const: cd type: string - const: BS type: string - const: bs type: string - const: CC type: string - const: cc type: string - const: CF type: string - const: cf type: string - const: CK type: string - const: ck type: string - const: FK type: string - const: fk type: string - const: FO type: string - const: fo type: string - const: HM type: string - const: hm type: string - const: KM type: string - const: km type: string - const: KY type: string - const: ky type: string - const: MH type: string - const: mh type: string - const: MP type: string - const: mp type: string - const: TC type: string - const: tc type: string - const: TF type: string - const: tf type: string - const: UM type: string - const: um type: string - const: VA type: string - const: va type: string - const: XK type: string - const: xk type: string - const: AN type: string - const: an type: string - type: 'null' brand: description: The brand name of an entity example: minespider type: string phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - minLength: 1 maxLength: 6 type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - minLength: 1 maxLength: 6 type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - minLength: 3 maxLength: 20 type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: number - type: 'null' longitude: description: Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: number - type: 'null' googleMapsLink: description: A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' required: - name - type example: name: Minespider Germany GmbH type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f email: john@mail.com avatar: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 about: We enable you to be at the cutting-edge of sustainability. cahraArea: false streetAddress: Dunckerstrasse 79 city: Berlin country: DE brand: minespider phoneCountryCode: '+49' phoneAreaCode: '30' phoneNumber: '123456' registrationNumber: '123456' latitude: 52.543304 longitude: 13.421241 googleMapsLink: https://goo.gl/maps/7XARjBaCaWoJeqEA6 description: Request payload for Create a new entity. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a new entity. tags: - Entities get: description: Fetches a collection of entities based on the provided criteria. operationId: EntityController_getMany parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true - name: approved required: false in: query schema: description: Whether an entity approved or not example: true type: boolean description: Whether an entity approved or not example: true - name: cahraArea required: false in: query schema: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false - name: createdBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created this entity/entities. description: UUID of the member who created this entity/entities. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: order required: false in: query schema: default: name type: string description: Result ordering expression. example: name - name: alias required: false in: query schema: description: Unique slugged alias of entity name type: string description: Unique slugged alias of entity name example: alias - name: relation required: false in: query schema: description: >- Allowed values: sender, invited, granter, grantee, recipient, sender : Entities that have sent PPs to the current user recipient: Entities that have received PPs from the current user invited: Entities that were invited by the current user type: string description: |- Allowed values: sender, invited, granter, grantee, recipient, sender : Entities that have sent PPs to the current user recipient: Entities that have received PPs from the current user invited: Entities that were invited by the current user example: relation responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve multiple entities. tags: - Entities /v1/entity/entities/invite: post: description: >- Sends an invitation to the specified entity to join or participate in the system. operationId: EntityController_invite parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create entity body schema type: object properties: name: minLength: 3 maxLength: 255 description: Entity name example: Minespider Germany GmbH type: string type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID required: - id email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string country: description: The country's name where an entity is located officially example: Germany anyOf: - type: string - type: 'null' brand: description: Brand of the entity example: minespider anyOf: - const: minespider type: string - const: ptl type: string - const: bosch type: string firstName: description: User first name example: John type: string lastName: description: User last name example: Doe type: string required: - name - type - firstName - lastName example: name: Minespider Germany GmbH type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f email: john@mail.com country: Germany brand: minespider firstName: John lastName: Doe description: Request payload for Invite an entity. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: entity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy invitation: description: Invitation type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Invitation UUID firstName: description: Invitee first name example: John type: string lastName: description: Invitee last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string invitee: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy inviter: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy expirationDate: description: Timestamp of invitation expiration date example: 1686042132022 type: number status: description: >- Condition of the invitation. Possible values: open, denied, accepted example: open anyOf: - const: open type: string - const: denied type: string - const: accepted type: string respondedAt: description: Timestamp of invitee response date example: 1686042132022 type: number createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - invitee - inviter - expirationDate - status - respondedAt - createdAt - createdBy link: description: Invitation link type: string required: - entity - invitation - link required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f invitation: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com invitee: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f inviter: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f expirationDate: 1686042132022 status: open respondedAt: 1686042132022 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f link: link '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Invite an entity. tags: - Entities - Invitations /v1/entity/entities/{entityId}/members: post: description: Adds a new member to the system with the provided details. operationId: MemberController_create parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create member body schema type: object properties: firstName: minLength: 1 maxLength: 255 type: string lastName: minLength: 1 maxLength: 255 type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string gender: anyOf: - anyOf: - const: male type: string - const: female type: string - const: non-binary type: string - type: 'null' notifications: default: false type: boolean timezone: type: string password: minLength: 8 maxLength: 72 format: new-password description: >- Password with at least 8 Unicode characters and at most 72 UTF-8 bytes. Spaces are preserved. type: string password2: minLength: 8 maxLength: 72 format: new-password description: >- Password with at least 8 Unicode characters and at most 72 UTF-8 bytes. Spaces are preserved. type: string avatar: pattern: ^https?://\S+$ description: >- Avatar of the member to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 type: string invitation: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - firstName - lastName - email - timezone - password - password2 description: Request payload for Create a new member. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Member type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Member UUID firstName: description: Member first name example: John type: string lastName: description: Member last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string avatar: description: URL to avatar assigned to a member example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' gender: anyOf: - description: 'Member''s gender: male, female, non-binary' example: male anyOf: - const: male type: string - const: female type: string - const: non-binary type: string - type: 'null' timezone: description: >- Timezone to help member on dates and other locale purposes example: Europe/Berlin type: string language: description: >- Language that is preferable for user. Uses ISO 639-1 or BCP47 format. example: en type: string entity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy role: description: 'Member''s role. Possible values: member, admin' example: admin anyOf: - anyOf: - const: admin type: string - const: member type: string - type: string user: description: User type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID firstName: description: User first name example: John type: string lastName: description: User last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string emailVerified: default: false description: Whether user email verified or not example: true type: boolean emailVerifiedAt: description: Timestamp of email verification date example: 1686042132022 type: number admin: default: false description: Whether user is admin or not example: true type: boolean active: default: false description: Whether user is active or not example: true type: boolean activatedAt: description: Timestamp of user account activation date example: 1686042132022 type: number lastLogin: description: Timestamp of user last login date example: 1686042132022 type: number resetPasswordNextLogin: default: false description: >- Whether the user must update its password on next login example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - emailVerified - admin - active - resetPasswordNextLogin - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - gender - timezone - entity - role - user - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com gender: male timezone: Europe/Berlin entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f role: admin user: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com emailVerified: true admin: true active: true resetPasswordNextLogin: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a new member. tags: - Members get: description: >- Fetches a collection of members based on the specified criteria or filters. operationId: MemberController_getMany parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: role required: false in: query schema: anyOf: - const: admin type: string - const: member type: string description: Role value used by this operation. example: admin - name: createdBy required: false in: query schema: type: string description: Created by value used by this operation. example: created-by - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: gender required: false in: query schema: anyOf: - const: male type: string - const: female type: string - const: non-binary type: string description: Gender value used by this operation. example: male - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Member type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Member UUID firstName: description: Member first name example: John type: string lastName: description: Member last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string avatar: description: URL to avatar assigned to a member example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' gender: anyOf: - description: 'Member''s gender: male, female, non-binary' example: male anyOf: - const: male type: string - const: female type: string - const: non-binary type: string - type: 'null' timezone: description: >- Timezone to help member on dates and other locale purposes example: Europe/Berlin type: string language: description: >- Language that is preferable for user. Uses ISO 639-1 or BCP47 format. example: en type: string entity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy role: description: 'Member''s role. Possible values: member, admin' example: admin anyOf: - anyOf: - const: admin type: string - const: member type: string - type: string user: description: User type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID firstName: description: User first name example: John type: string lastName: description: User last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string emailVerified: default: false description: Whether user email verified or not example: true type: boolean emailVerifiedAt: description: Timestamp of email verification date example: 1686042132022 type: number admin: default: false description: Whether user is admin or not example: true type: boolean active: default: false description: Whether user is active or not example: true type: boolean activatedAt: description: Timestamp of user account activation date example: 1686042132022 type: number lastLogin: description: Timestamp of user last login date example: 1686042132022 type: number resetPasswordNextLogin: default: false description: >- Whether the user must update its password on next login example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - emailVerified - admin - active - resetPasswordNextLogin - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - gender - timezone - entity - role - user - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com gender: male timezone: Europe/Berlin entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f role: admin user: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com emailVerified: true admin: true active: true resetPasswordNextLogin: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve multiple members. tags: - Members /v1/entity/entities/{entityId}/members/{id}: get: description: Fetches the details of a specific member based on the provided ID. operationId: MemberController_getOne parameters: - name: id required: true in: path schema: type: string description: Member identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Member type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Member UUID firstName: description: Member first name example: John type: string lastName: description: Member last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string avatar: description: URL to avatar assigned to a member example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' gender: anyOf: - description: 'Member''s gender: male, female, non-binary' example: male anyOf: - const: male type: string - const: female type: string - const: non-binary type: string - type: 'null' timezone: description: >- Timezone to help member on dates and other locale purposes example: Europe/Berlin type: string language: description: >- Language that is preferable for user. Uses ISO 639-1 or BCP47 format. example: en type: string entity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy role: description: 'Member''s role. Possible values: member, admin' example: admin anyOf: - anyOf: - const: admin type: string - const: member type: string - type: string user: description: User type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID firstName: description: User first name example: John type: string lastName: description: User last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string emailVerified: default: false description: Whether user email verified or not example: true type: boolean emailVerifiedAt: description: Timestamp of email verification date example: 1686042132022 type: number admin: default: false description: Whether user is admin or not example: true type: boolean active: default: false description: Whether user is active or not example: true type: boolean activatedAt: description: Timestamp of user account activation date example: 1686042132022 type: number lastLogin: description: Timestamp of user last login date example: 1686042132022 type: number resetPasswordNextLogin: default: false description: >- Whether the user must update its password on next login example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - emailVerified - admin - active - resetPasswordNextLogin - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - gender - timezone - entity - role - user - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com gender: male timezone: Europe/Berlin entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f role: admin user: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com emailVerified: true admin: true active: true resetPasswordNextLogin: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve member by ID. tags: - Members patch: description: Modifies the details of an existing member in the system. operationId: MemberController_update parameters: - name: id required: true in: path schema: type: string description: Member identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: minProperties: 1 description: Patch member body schema type: object properties: firstName: minLength: 1 maxLength: 255 type: string lastName: minLength: 1 maxLength: 255 type: string avatar: pattern: ^https?://\S+$ description: >- Avatar of the member to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 type: string gender: anyOf: - anyOf: - const: male type: string - const: female type: string - const: non-binary type: string - type: 'null' timezone: type: string notifications: type: boolean language: maxLength: 5 type: string active: description: Whether the member's linked user can authenticate type: boolean example: firstName: first-name lastName: last-name avatar: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 gender: male timezone: Europe/Lisbon notifications: true language: langu active: true description: Request payload for Edit a member. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Member type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Member UUID firstName: description: Member first name example: John type: string lastName: description: Member last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string avatar: description: URL to avatar assigned to a member example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' gender: anyOf: - description: 'Member''s gender: male, female, non-binary' example: male anyOf: - const: male type: string - const: female type: string - const: non-binary type: string - type: 'null' timezone: description: >- Timezone to help member on dates and other locale purposes example: Europe/Berlin type: string language: description: >- Language that is preferable for user. Uses ISO 639-1 or BCP47 format. example: en type: string entity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy role: description: 'Member''s role. Possible values: member, admin' example: admin anyOf: - anyOf: - const: admin type: string - const: member type: string - type: string user: description: User type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: User UUID firstName: description: User first name example: John type: string lastName: description: User last name example: Doe type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string emailVerified: default: false description: Whether user email verified or not example: true type: boolean emailVerifiedAt: description: Timestamp of email verification date example: 1686042132022 type: number admin: default: false description: Whether user is admin or not example: true type: boolean active: default: false description: Whether user is active or not example: true type: boolean activatedAt: description: Timestamp of user account activation date example: 1686042132022 type: number lastLogin: description: Timestamp of user last login date example: 1686042132022 type: number resetPasswordNextLogin: default: false description: >- Whether the user must update its password on next login example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - emailVerified - admin - active - resetPasswordNextLogin - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - firstName - lastName - email - gender - timezone - entity - role - user - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com gender: male timezone: Europe/Berlin entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f role: admin user: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: John lastName: Doe email: john@mail.com emailVerified: true admin: true active: true resetPasswordNextLogin: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Edit a member. tags: - Members delete: description: >- Deletes a member from the system, revoking all associated access and privileges. operationId: MemberController_remove parameters: - name: id required: true in: path schema: type: string description: Member identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Remove a member. tags: - Members /v1/entity/entities/{entityId}/members/{id}/demotion: post: description: >- Changes a user's role from 'admin' to 'member', reducing their privileges within the system. operationId: MemberController_demote parameters: - name: id required: true in: path schema: type: string description: Member identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Admin demotion body schema type: object properties: role: default: member const: member type: string example: role: member description: Request payload for Demote a member. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Demote a member. tags: - Members /v1/entity/entities/{entityId}/members/{id}/promotion: post: description: >- Changes a user's role from 'member' to 'admin', granting them elevated privileges within the system. operationId: MemberController_promote parameters: - name: id required: true in: path schema: type: string description: Member identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Member promotion body schema type: object properties: role: default: admin const: admin type: string example: role: admin description: Request payload for Promote a member. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Promote a member. tags: - Members /v1/entity/entities/{entityId}/members/invite: post: description: Sends an invitation to a user to join the system as a member. operationId: MemberController_invite parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: entityId required: true in: path description: Entity UUID schema: {} example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Create member body schema type: object properties: email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string firstName: description: User first name example: John type: string lastName: description: User last name example: Doe type: string required: - firstName - lastName example: email: john@mail.com firstName: John lastName: Doe description: Request payload for Invite a member. responses: '201': description: Resource created successfully. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Invite a member. tags: - Members /v1/tenancy/access: post: description: >- Grants access to the tenant specified in the request body to the authenticated entity. operationId: TenantAccessController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create tenancy access body schema type: object properties: tenant: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant access UUID required: - tenant example: tenant: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: Request payload for Grant access to tenant. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant access UUID active: description: Whether an tenant access is active example: true type: boolean tenant: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant UUID name: description: Tenant name example: Minespider Germany GmbH type: string alias: description: Unique slug string of an tenant name example: minespider-germany-gmbh type: string secret: type: string active: description: Whether an tenant is active example: true type: boolean required: - createdAt - createdBy - id - name - alias - secret - active entity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id required: - createdAt - createdBy - id - active - tenant - entity required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true tenant: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH alias: minespider-germany-gmbh secret: secret active: true entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Grant access to tenant. tags: - Tenancy Access get: description: >- Fetches a collection of tenants to which the authenticated entity has been granted access. operationId: TenantAccessController_get parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant access UUID active: description: Whether an tenant access is active example: true type: boolean tenant: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant UUID name: description: Tenant name example: Minespider Germany GmbH type: string alias: description: Unique slug string of an tenant name example: minespider-germany-gmbh type: string secret: type: string active: description: Whether an tenant is active example: true type: boolean required: - createdAt - createdBy - id - name - alias - secret - active entity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id required: - createdAt - createdBy - id - active - tenant - entity required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true tenant: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH alias: minespider-germany-gmbh secret: secret active: true entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve tenants granted access by an entity. tags: - Tenancy Access /v1/tenancy/access/{id}: get: description: >- Fetches the details of a specific access granted to a tenant based on the provided criteria. operationId: TenantAccessController_getOne parameters: - name: id required: true in: path schema: type: string description: Access identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant access UUID active: description: Whether an tenant access is active example: true type: boolean tenant: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant UUID name: description: Tenant name example: Minespider Germany GmbH type: string alias: description: Unique slug string of an tenant name example: minespider-germany-gmbh type: string secret: type: string active: description: Whether an tenant is active example: true type: boolean required: - createdAt - createdBy - id - name - alias - secret - active entity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id required: - createdAt - createdBy - id - active - tenant - entity required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true tenant: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH alias: minespider-germany-gmbh secret: secret active: true entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve specific access granted to a tenant. tags: - Tenancy Access delete: description: Revokes the access granted to an entity by the specified tenant ID. operationId: TenantAccessController_remove parameters: - name: id required: true in: path schema: type: string description: Access identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant access UUID active: description: Whether an tenant access is active example: true type: boolean tenant: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant UUID name: description: Tenant name example: Minespider Germany GmbH type: string alias: description: Unique slug string of an tenant name example: minespider-germany-gmbh type: string secret: type: string active: description: Whether an tenant is active example: true type: boolean required: - createdAt - createdBy - id - name - alias - secret - active entity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id required: - createdAt - createdBy - id - active - tenant - entity required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true tenant: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH alias: minespider-germany-gmbh secret: secret active: true entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Revoke granted access to entity by tenant ID. tags: - Tenancy Access /v1/tenancy/tenants: post: description: >- Adds a new tenant to the system. Tenant ID and Tenant Secret will be generated automatically. operationId: TenantController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create tenant body schema type: object properties: name: type: string active: type: boolean required: - name example: name: name active: true description: Request payload for Create a tenant. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant UUID name: description: Tenant name example: Minespider Germany GmbH type: string alias: description: Unique slug string of an tenant name example: minespider-germany-gmbh type: string secret: type: string active: description: Whether an tenant is active example: true type: boolean required: - createdAt - createdBy - id - name - alias - secret - active required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH alias: minespider-germany-gmbh secret: secret active: true '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a tenant. tags: - Tenants get: description: >- Fetches a collection of tenants based on the specified criteria or filters. operationId: TenantController_find parameters: - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant UUID name: description: Tenant name example: Minespider Germany GmbH type: string alias: description: Unique slug string of an tenant name example: minespider-germany-gmbh type: string secret: type: string active: description: Whether an tenant is active example: true type: boolean required: - createdAt - createdBy - id - name - alias - secret - active required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH alias: minespider-germany-gmbh secret: secret active: true '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve the collection of tenants. tags: - Tenants /v1/tenancy/tenants/{id}: get: description: >- Fetches the details of a specific tenant based on the provided criteria or ID. operationId: TenantController_get parameters: - name: id required: true in: path schema: type: string description: Tenant identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant UUID name: description: Tenant name example: Minespider Germany GmbH type: string alias: description: Unique slug string of an tenant name example: minespider-germany-gmbh type: string secret: type: string active: description: Whether an tenant is active example: true type: boolean required: - createdAt - createdBy - id - name - alias - secret - active required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH alias: minespider-germany-gmbh secret: secret active: true '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve a tenant. tags: - Tenants delete: description: >- Removes a specified tenant from the system, revoking its access and data. operationId: TenantController_remove parameters: - name: id required: true in: path schema: type: string description: Tenant identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a tenant. tags: - Tenants /v1/tenancy/tenants/{id}/activate: post: description: >- Activates a specified tenant, enabling its services and functionality in the system. operationId: TenantController_activate parameters: - name: id required: true in: path schema: type: string description: Tenant identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant UUID name: description: Tenant name example: Minespider Germany GmbH type: string alias: description: Unique slug string of an tenant name example: minespider-germany-gmbh type: string secret: type: string active: description: Whether an tenant is active example: true type: boolean required: - createdAt - createdBy - id - name - alias - secret - active required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH alias: minespider-germany-gmbh secret: secret active: true '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Activate a tenant. tags: - Tenants /v1/tenancy/tenants/{id}/deactivate: post: description: >- Sets the active flag to false, preventing the tenant from making any API calls to the Tenancy service. operationId: TenantController_deactivate parameters: - name: id required: true in: path schema: type: string description: Tenant identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant UUID name: description: Tenant name example: Minespider Germany GmbH type: string alias: description: Unique slug string of an tenant name example: minespider-germany-gmbh type: string secret: type: string active: description: Whether an tenant is active example: true type: boolean required: - createdAt - createdBy - id - name - alias - secret - active required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH alias: minespider-germany-gmbh secret: secret active: true '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Deactivate a tenant. tags: - Tenants /v1/tenancy/tenants/{id}/credentials/rotate: post: description: >- Replaces the tenant secret. This endpoint only accepts the current credential of the same tenant. operationId: TenantController_rotateCredential parameters: - name: id required: true in: path schema: type: string description: Tenant identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: secret: type: string required: - secret required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: secret: secret '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Rotate the current tenant credential. tags: - Tenants /v1/storage/image: post: description: Allows the user to upload an image file to the system. operationId: ImageController_upload parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Upload file body type: object properties: file: format: binary description: The file to upload as form-data type: string required: - file description: Request payload for Upload an image. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: File type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID active: description: Whether file active or not example: true type: boolean encoding: description: Encoding of the file example: 7bit type: string name: minLength: 1 maxLength: 1000 description: File name example: Regulations type: string title: minLength: 1 maxLength: 1000 description: Title of the file example: Regulations type: string mime: description: Mime type of the file example: image/png type: string size: description: File size example: 23598 type: number checksum: description: Hashed value of file content example: 105ecaefa8c48ea94bb79d6009247eff5c1e5dbb type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File owner UUID visibility: description: >- Visibility layer of file. Possible values: public, private example: public anyOf: - const: public type: string - const: private type: string uri: pattern: ^https?://\S+$ description: String representation of file URI example: >- https://ams3.digitaloceanspaces.com/files.qa.minespider.com/5292e169-4dfe-4a22-9220-68692e9b43d2 type: string original: $ref: >- #/paths/~1v1~1storage~1image/post/responses/200/content/application~1json/schema/properties/content alternatives: description: >- An array of resized alternatives of the file, if the file is an image type: array items: $ref: >- #/paths/~1v1~1storage~1image/post/responses/200/content/application~1json/schema/properties/content relations: type: array items: description: File relations type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File relations UUID active: description: Whether file relations active or not example: true type: boolean target: description: File relations target example: Target type: string type: description: File relations type example: Type type: string required: - id - active - target - type required: - createdAt - createdBy - id - active - encoding - name - title - mime - size - checksum - ownedBy - visibility - alternatives required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Upload an image. tags: - File Storage get: description: >- Fetches a collection of images based on the specified criteria or filters. operationId: ImageController_findMany parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: File type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID active: description: Whether file active or not example: true type: boolean encoding: description: Encoding of the file example: 7bit type: string name: minLength: 1 maxLength: 1000 description: File name example: Regulations type: string title: minLength: 1 maxLength: 1000 description: Title of the file example: Regulations type: string mime: description: Mime type of the file example: image/png type: string size: description: File size example: 23598 type: number checksum: description: Hashed value of file content example: 105ecaefa8c48ea94bb79d6009247eff5c1e5dbb type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File owner UUID visibility: description: >- Visibility layer of file. Possible values: public, private example: public anyOf: - const: public type: string - const: private type: string uri: pattern: ^https?://\S+$ description: String representation of file URI example: >- https://ams3.digitaloceanspaces.com/files.qa.minespider.com/5292e169-4dfe-4a22-9220-68692e9b43d2 type: string original: $ref: >- #/paths/~1v1~1storage~1image/get/responses/200/content/application~1json/schema/properties/content/items alternatives: description: >- An array of resized alternatives of the file, if the file is an image type: array items: $ref: >- #/paths/~1v1~1storage~1image/get/responses/200/content/application~1json/schema/properties/content/items relations: type: array items: description: File relations type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File relations UUID active: description: Whether file relations active or not example: true type: boolean target: description: File relations target example: Target type: string type: description: File relations type example: Type type: string required: - id - active - target - type required: - createdAt - createdBy - id - active - encoding - name - title - mime - size - checksum - ownedBy - visibility - alternatives required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve multiple images. tags: - File Storage /v1/storage/image/{id}: delete: description: Removes the specified image from the system. operationId: ImageController_delete parameters: - name: id required: true in: path schema: type: string description: Image identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete an image. tags: - File Storage get: description: Fetches the details of a specific image based on the provided ID. operationId: ImageController_findOne parameters: - name: id required: true in: path schema: type: string description: Image identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: File type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID active: description: Whether file active or not example: true type: boolean encoding: description: Encoding of the file example: 7bit type: string name: minLength: 1 maxLength: 1000 description: File name example: Regulations type: string title: minLength: 1 maxLength: 1000 description: Title of the file example: Regulations type: string mime: description: Mime type of the file example: image/png type: string size: description: File size example: 23598 type: number checksum: description: Hashed value of file content example: 105ecaefa8c48ea94bb79d6009247eff5c1e5dbb type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File owner UUID visibility: description: >- Visibility layer of file. Possible values: public, private example: public anyOf: - const: public type: string - const: private type: string uri: pattern: ^https?://\S+$ description: String representation of file URI example: >- https://ams3.digitaloceanspaces.com/files.qa.minespider.com/5292e169-4dfe-4a22-9220-68692e9b43d2 type: string original: $ref: >- #/paths/~1v1~1storage~1image~1{id}/get/responses/200/content/application~1json/schema/properties/content alternatives: description: >- An array of resized alternatives of the file, if the file is an image type: array items: $ref: >- #/paths/~1v1~1storage~1image~1{id}/get/responses/200/content/application~1json/schema/properties/content relations: type: array items: description: File relations type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File relations UUID active: description: Whether file relations active or not example: true type: boolean target: description: File relations target example: Target type: string type: description: File relations type example: Type type: string required: - id - active - target - type required: - createdAt - createdBy - id - active - encoding - name - title - mime - size - checksum - ownedBy - visibility - alternatives required: - _meta - messages - content security: - {} - bearer: [] - cookie: [] summary: Retrieve image by ID. tags: - File Storage /v1/storage/file: post: description: Allows a user to upload a file to the system. operationId: FileController_upload parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: visibility: description: 'Visibility layer of file. Possible values: public, private' example: public anyOf: - const: public type: string - const: private type: string title: minLength: 1 maxLength: 1000 description: Title of the file example: Regulations type: string file: format: binary description: The file to upload as form-data type: string required: - file description: Request payload for Upload a file. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: File type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID active: description: Whether file active or not example: true type: boolean encoding: description: Encoding of the file example: 7bit type: string name: minLength: 1 maxLength: 1000 description: File name example: Regulations type: string title: minLength: 1 maxLength: 1000 description: Title of the file example: Regulations type: string mime: description: Mime type of the file example: image/png type: string size: description: File size example: 23598 type: number checksum: description: Hashed value of file content example: 105ecaefa8c48ea94bb79d6009247eff5c1e5dbb type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File owner UUID visibility: description: >- Visibility layer of file. Possible values: public, private example: public anyOf: - const: public type: string - const: private type: string uri: pattern: ^https?://\S+$ description: String representation of file URI example: >- https://ams3.digitaloceanspaces.com/files.qa.minespider.com/5292e169-4dfe-4a22-9220-68692e9b43d2 type: string original: $ref: >- #/paths/~1v1~1storage~1file/post/responses/200/content/application~1json/schema/properties/content alternatives: description: >- An array of resized alternatives of the file, if the file is an image type: array items: $ref: >- #/paths/~1v1~1storage~1file/post/responses/200/content/application~1json/schema/properties/content relations: type: array items: description: File relations type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File relations UUID active: description: Whether file relations active or not example: true type: boolean target: description: File relations target example: Target type: string type: description: File relations type example: Type type: string required: - id - active - target - type required: - createdAt - createdBy - id - active - encoding - name - title - mime - size - checksum - ownedBy - visibility - alternatives required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Upload a file. tags: - File Storage get: description: >- Fetches a collection of files based on the specified criteria or filters. operationId: FileController_findMany parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: File type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID active: description: Whether file active or not example: true type: boolean encoding: description: Encoding of the file example: 7bit type: string name: minLength: 1 maxLength: 1000 description: File name example: Regulations type: string title: minLength: 1 maxLength: 1000 description: Title of the file example: Regulations type: string mime: description: Mime type of the file example: image/png type: string size: description: File size example: 23598 type: number checksum: description: Hashed value of file content example: 105ecaefa8c48ea94bb79d6009247eff5c1e5dbb type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File owner UUID visibility: description: >- Visibility layer of file. Possible values: public, private example: public anyOf: - const: public type: string - const: private type: string uri: pattern: ^https?://\S+$ description: String representation of file URI example: >- https://ams3.digitaloceanspaces.com/files.qa.minespider.com/5292e169-4dfe-4a22-9220-68692e9b43d2 type: string original: $ref: >- #/paths/~1v1~1storage~1file/get/responses/200/content/application~1json/schema/properties/content/items alternatives: description: >- An array of resized alternatives of the file, if the file is an image type: array items: $ref: >- #/paths/~1v1~1storage~1file/get/responses/200/content/application~1json/schema/properties/content/items relations: type: array items: description: File relations type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File relations UUID active: description: Whether file relations active or not example: true type: boolean target: description: File relations target example: Target type: string type: description: File relations type example: Type type: string required: - id - active - target - type required: - createdAt - createdBy - id - active - encoding - name - title - mime - size - checksum - ownedBy - visibility - alternatives required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve multiple files. tags: - File Storage /v1/storage/file/maximum-evidence-file-size: get: description: >- Returns the upload limit, in bytes, currently applied to evidence files for the caller's entity. operationId: FileController_getMaximumEvidenceFileSize parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: value: type: integer required: - value required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: value: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get the current entity's effective maximum evidence file size. tags: - File Storage /v1/storage/file/{id}: delete: description: >- Removes an unreferenced file. Files referenced by passport metadata cannot be deleted. operationId: FileController_delete parameters: - name: id required: true in: path schema: type: string description: File identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a file. tags: - File Storage get: description: Fetches the details of a specific file based on the provided ID. operationId: FileController_findOne parameters: - name: id required: true in: path schema: type: string description: File identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: File type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID active: description: Whether file active or not example: true type: boolean encoding: description: Encoding of the file example: 7bit type: string name: minLength: 1 maxLength: 1000 description: File name example: Regulations type: string title: minLength: 1 maxLength: 1000 description: Title of the file example: Regulations type: string mime: description: Mime type of the file example: image/png type: string size: description: File size example: 23598 type: number checksum: description: Hashed value of file content example: 105ecaefa8c48ea94bb79d6009247eff5c1e5dbb type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File owner UUID visibility: description: >- Visibility layer of file. Possible values: public, private example: public anyOf: - const: public type: string - const: private type: string uri: pattern: ^https?://\S+$ description: String representation of file URI example: >- https://ams3.digitaloceanspaces.com/files.qa.minespider.com/5292e169-4dfe-4a22-9220-68692e9b43d2 type: string original: $ref: >- #/paths/~1v1~1storage~1file~1{id}/get/responses/200/content/application~1json/schema/properties/content alternatives: description: >- An array of resized alternatives of the file, if the file is an image type: array items: $ref: >- #/paths/~1v1~1storage~1file~1{id}/get/responses/200/content/application~1json/schema/properties/content relations: type: array items: description: File relations type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File relations UUID active: description: Whether file relations active or not example: true type: boolean target: description: File relations target example: Target type: string type: description: File relations type example: Type type: string required: - id - active - target - type required: - createdAt - createdBy - id - active - encoding - name - title - mime - size - checksum - ownedBy - visibility - alternatives required: - _meta - messages - content security: - {} - bearer: [] - cookie: [] summary: Retrieve file by ID. tags: - File Storage patch: description: >- Updates the file title or visibility. Files referenced by passport metadata cannot be made public. To replace content, upload a new file and update the metadata reference. operationId: FileController_update parameters: - name: id required: true in: path schema: type: string description: File identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: minProperties: 1 description: Save file body schema type: object properties: visibility: description: 'Visibility layer of file. Possible values: public, private' example: public anyOf: - const: public type: string - const: private type: string title: minLength: 1 maxLength: 1000 description: Title of the file example: Regulations type: string example: visibility: public title: Regulations description: Request payload for Edit a file. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: File type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID active: description: Whether file active or not example: true type: boolean encoding: description: Encoding of the file example: 7bit type: string name: minLength: 1 maxLength: 1000 description: File name example: Regulations type: string title: minLength: 1 maxLength: 1000 description: Title of the file example: Regulations type: string mime: description: Mime type of the file example: image/png type: string size: description: File size example: 23598 type: number checksum: description: Hashed value of file content example: 105ecaefa8c48ea94bb79d6009247eff5c1e5dbb type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File owner UUID visibility: description: >- Visibility layer of file. Possible values: public, private example: public anyOf: - const: public type: string - const: private type: string uri: pattern: ^https?://\S+$ description: String representation of file URI example: >- https://ams3.digitaloceanspaces.com/files.qa.minespider.com/5292e169-4dfe-4a22-9220-68692e9b43d2 type: string original: $ref: >- #/paths/~1v1~1storage~1file~1{id}/patch/responses/200/content/application~1json/schema/properties/content alternatives: description: >- An array of resized alternatives of the file, if the file is an image type: array items: $ref: >- #/paths/~1v1~1storage~1file~1{id}/patch/responses/200/content/application~1json/schema/properties/content relations: type: array items: description: File relations type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File relations UUID active: description: Whether file relations active or not example: true type: boolean target: description: File relations target example: Target type: string type: description: File relations type example: Type type: string required: - id - active - target - type required: - createdAt - createdBy - id - active - encoding - name - title - mime - size - checksum - ownedBy - visibility - alternatives required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Edit a file. tags: - File Storage /v1/storage/file/{id}/download: get: description: Allows the user to download the specified file from the system. operationId: FileController_download parameters: - name: id required: true in: path schema: type: string description: File identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: String representation of a file URL type: string required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: content security: - {} - bearer: [] - cookie: [] summary: Download a file. tags: - File Storage /v1/storage/file/{id}/serve: get: description: Provides the specified file for access or download by the user. operationId: FileController_serve parameters: - name: id required: true in: path schema: type: string description: File identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Serves file type: string required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: content security: - {} - bearer: [] - cookie: [] summary: Serve a file. tags: - File Storage /v1/tenancy/tenants/{tenant}/entities: get: description: >- Fetches a collection of entities managed by the specified tenant. Please use the tenantId assigned to you by Minespider. operationId: TenancyEntityController_get parameters: - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant access UUID active: description: Whether an tenant access is active example: true type: boolean tenant: type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tenant UUID name: description: Tenant name example: Minespider Germany GmbH type: string alias: description: Unique slug string of an tenant name example: minespider-germany-gmbh type: string secret: type: string active: description: Whether an tenant is active example: true type: boolean required: - createdAt - createdBy - id - name - alias - secret - active entity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id required: - createdAt - createdBy - id - active - tenant - entity required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true tenant: createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH alias: minespider-germany-gmbh secret: secret active: true entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve entities managed by a particular tenant. tags: - Tenant Entities post: description: >- Access to the newly created entity will be automatically granted, and an admin member will be created. To impersonate the entity, retrieve the admin member ID and use the impersonate endpoint to acquire the access token for Minespider API. For available entity types, refer to the 'Entity / Entity types' endpoint. operationId: TenancyEntityController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant requestBody: required: true content: application/json: schema: description: >- Create a tenant-managed entity and its initial passwordless administrator type: object properties: name: minLength: 3 maxLength: 255 description: Entity name example: Minespider Germany GmbH type: string type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID required: - id email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string avatar: pattern: ^https?://\S+$ description: >- Avatar of the entity to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 type: string about: description: Entity about information example: We enable you to be at the cutting-edge of sustainability. type: string cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - minLength: 3 maxLength: 255 type: string - type: 'null' city: description: The city's name where an entity is located officially example: Berlin anyOf: - minLength: 3 maxLength: 255 type: string - type: 'null' country: description: The country's code where an entity is located officially example: DE anyOf: - anyOf: - const: AD type: string - const: ad type: string - const: AF type: string - const: af type: string - const: AG type: string - const: ag type: string - const: AI type: string - const: ai type: string - const: AL type: string - const: al type: string - const: AM type: string - const: am type: string - const: AO type: string - const: ao type: string - const: AQ type: string - const: aq type: string - const: AR type: string - const: ar type: string - const: AS type: string - const: as type: string - const: AT type: string - const: at type: string - const: AU type: string - const: au type: string - const: AW type: string - const: aw type: string - const: AX type: string - const: ax type: string - const: AZ type: string - const: az type: string - const: BA type: string - const: ba type: string - const: BB type: string - const: bb type: string - const: BD type: string - const: bd type: string - const: BE type: string - const: be type: string - const: BF type: string - const: bf type: string - const: BG type: string - const: bg type: string - const: BH type: string - const: bh type: string - const: BI type: string - const: bi type: string - const: BJ type: string - const: bj type: string - const: BL type: string - const: bl type: string - const: BM type: string - const: bm type: string - const: BN type: string - const: bn type: string - const: BO type: string - const: bo type: string - const: BQ type: string - const: bq type: string - const: BR type: string - const: br type: string - const: BT type: string - const: bt type: string - const: BV type: string - const: bv type: string - const: BW type: string - const: bw type: string - const: BY type: string - const: by type: string - const: BZ type: string - const: bz type: string - const: CA type: string - const: ca type: string - const: CH type: string - const: ch type: string - const: CI type: string - const: ci type: string - const: CL type: string - const: cl type: string - const: CM type: string - const: cm type: string - const: CN type: string - const: cn type: string - const: CO type: string - const: co type: string - const: CR type: string - const: cr type: string - const: CU type: string - const: cu type: string - const: CV type: string - const: cv type: string - const: CW type: string - const: cw type: string - const: CX type: string - const: cx type: string - const: CY type: string - const: cy type: string - const: DE type: string - const: de type: string - const: DJ type: string - const: dj type: string - const: DK type: string - const: dk type: string - const: DM type: string - const: dm type: string - const: DZ type: string - const: dz type: string - const: EC type: string - const: ec type: string - const: EE type: string - const: ee type: string - const: EG type: string - const: eg type: string - const: EH type: string - const: eh type: string - const: ER type: string - const: er type: string - const: ES type: string - const: es type: string - const: ET type: string - const: et type: string - const: FI type: string - const: fi type: string - const: FJ type: string - const: fj type: string - const: FM type: string - const: fm type: string - const: FR type: string - const: fr type: string - const: GA type: string - const: ga type: string - const: GD type: string - const: gd type: string - const: GE type: string - const: ge type: string - const: GF type: string - const: gf type: string - const: GG type: string - const: gg type: string - const: GH type: string - const: gh type: string - const: GI type: string - const: gi type: string - const: GL type: string - const: gl type: string - const: GN type: string - const: gn type: string - const: GP type: string - const: gp type: string - const: GQ type: string - const: gq type: string - const: GR type: string - const: gr type: string - const: GS type: string - const: gs type: string - const: GT type: string - const: gt type: string - const: GU type: string - const: gu type: string - const: GW type: string - const: gw type: string - const: GY type: string - const: gy type: string - const: HK type: string - const: hk type: string - const: HN type: string - const: hn type: string - const: HR type: string - const: hr type: string - const: HT type: string - const: ht type: string - const: HU type: string - const: hu type: string - const: ID type: string - const: id type: string - const: IE type: string - const: ie type: string - const: IL type: string - const: il type: string - const: IM type: string - const: im type: string - const: IN type: string - const: in type: string - const: IO type: string - const: io type: string - const: IQ type: string - const: iq type: string - const: IR type: string - const: ir type: string - const: IS type: string - const: is type: string - const: IT type: string - const: it type: string - const: JE type: string - const: je type: string - const: JM type: string - const: jm type: string - const: JO type: string - const: jo type: string - const: JP type: string - const: jp type: string - const: KE type: string - const: ke type: string - const: KG type: string - const: kg type: string - const: KH type: string - const: kh type: string - const: KP type: string - const: kp type: string - const: KR type: string - const: kr type: string - const: KI type: string - const: ki type: string - const: KN type: string - const: kn type: string - const: KW type: string - const: kw type: string - const: KZ type: string - const: kz type: string - const: LB type: string - const: lb type: string - const: LC type: string - const: lc type: string - const: LI type: string - const: li type: string - const: LK type: string - const: lk type: string - const: LR type: string - const: lr type: string - const: LS type: string - const: ls type: string - const: LT type: string - const: lt type: string - const: LU type: string - const: lu type: string - const: LV type: string - const: lv type: string - const: LY type: string - const: ly type: string - const: MA type: string - const: ma type: string - const: MC type: string - const: mc type: string - const: ME type: string - const: me type: string - const: MF type: string - const: mf type: string - const: MG type: string - const: mg type: string - const: ML type: string - const: ml type: string - const: MM type: string - const: mm type: string - const: MN type: string - const: mn type: string - const: MO type: string - const: mo type: string - const: MQ type: string - const: mq type: string - const: MR type: string - const: mr type: string - const: MS type: string - const: ms type: string - const: MT type: string - const: mt type: string - const: MU type: string - const: mu type: string - const: MV type: string - const: mv type: string - const: MW type: string - const: mw type: string - const: MX type: string - const: mx type: string - const: MY type: string - const: my type: string - const: MZ type: string - const: mz type: string - const: NA type: string - const: na type: string - const: NC type: string - const: nc type: string - const: NF type: string - const: nf type: string - const: NG type: string - const: ng type: string - const: NI type: string - const: ni type: string - const: 'NO' type: string - const: 'no' type: string - const: NP type: string - const: np type: string - const: NR type: string - const: nr type: string - const: NU type: string - const: nu type: string - const: NZ type: string - const: nz type: string - const: OM type: string - const: om type: string - const: PA type: string - const: pa type: string - const: PE type: string - const: pe type: string - const: PF type: string - const: pf type: string - const: PG type: string - const: pg type: string - const: PK type: string - const: pk type: string - const: PL type: string - const: pl type: string - const: PM type: string - const: pm type: string - const: PN type: string - const: pn type: string - const: PR type: string - const: pr type: string - const: PS type: string - const: ps type: string - const: PT type: string - const: pt type: string - const: PW type: string - const: pw type: string - const: PY type: string - const: py type: string - const: QA type: string - const: qa type: string - const: RE type: string - const: re type: string - const: RO type: string - const: ro type: string - const: RS type: string - const: rs type: string - const: RU type: string - const: ru type: string - const: RW type: string - const: rw type: string - const: SA type: string - const: sa type: string - const: SB type: string - const: sb type: string - const: SC type: string - const: sc type: string - const: SE type: string - const: se type: string - const: SG type: string - const: sg type: string - const: SH type: string - const: sh type: string - const: SI type: string - const: si type: string - const: SJ type: string - const: sj type: string - const: SK type: string - const: sk type: string - const: SL type: string - const: sl type: string - const: SM type: string - const: sm type: string - const: SN type: string - const: sn type: string - const: SO type: string - const: so type: string - const: SR type: string - const: sr type: string - const: SS type: string - const: ss type: string - const: ST type: string - const: st type: string - const: SV type: string - const: sv type: string - const: SX type: string - const: sx type: string - const: SY type: string - const: sy type: string - const: TD type: string - const: td type: string - const: TG type: string - const: tg type: string - const: TH type: string - const: th type: string - const: TJ type: string - const: tj type: string - const: TK type: string - const: tk type: string - const: TL type: string - const: tl type: string - const: TM type: string - const: tm type: string - const: TN type: string - const: tn type: string - const: TO type: string - const: to type: string - const: TR type: string - const: tr type: string - const: TT type: string - const: tt type: string - const: TV type: string - const: tv type: string - const: TZ type: string - const: tz type: string - const: UA type: string - const: ua type: string - const: UG type: string - const: ug type: string - const: US type: string - const: us type: string - const: UY type: string - const: uy type: string - const: UZ type: string - const: uz type: string - const: VC type: string - const: vc type: string - const: VE type: string - const: ve type: string - const: VG type: string - const: vg type: string - const: VI type: string - const: vi type: string - const: VN type: string - const: vn type: string - const: VU type: string - const: vu type: string - const: WF type: string - const: wf type: string - const: WS type: string - const: ws type: string - const: YE type: string - const: ye type: string - const: YT type: string - const: yt type: string - const: ZA type: string - const: za type: string - const: ZM type: string - const: zm type: string - const: ZW type: string - const: zw type: string - const: SZ type: string - const: sz type: string - const: MK type: string - const: mk type: string - const: PH type: string - const: ph type: string - const: NL type: string - const: nl type: string - const: AE type: string - const: ae type: string - const: MD type: string - const: md type: string - const: GM type: string - const: gm type: string - const: DO type: string - const: do type: string - const: SD type: string - const: sd type: string - const: LA type: string - const: la type: string - const: TW type: string - const: tw type: string - const: CG type: string - const: cg type: string - const: CZ type: string - const: cz type: string - const: GB type: string - const: gb type: string - const: NE type: string - const: ne type: string - const: CD type: string - const: cd type: string - const: BS type: string - const: bs type: string - const: CC type: string - const: cc type: string - const: CF type: string - const: cf type: string - const: CK type: string - const: ck type: string - const: FK type: string - const: fk type: string - const: FO type: string - const: fo type: string - const: HM type: string - const: hm type: string - const: KM type: string - const: km type: string - const: KY type: string - const: ky type: string - const: MH type: string - const: mh type: string - const: MP type: string - const: mp type: string - const: TC type: string - const: tc type: string - const: TF type: string - const: tf type: string - const: UM type: string - const: um type: string - const: VA type: string - const: va type: string - const: XK type: string - const: xk type: string - const: AN type: string - const: an type: string - type: 'null' brand: description: The brand name of an entity example: minespider type: string phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - minLength: 1 maxLength: 6 type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - minLength: 1 maxLength: 6 type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - minLength: 3 maxLength: 20 type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: number - type: 'null' longitude: description: Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: number - type: 'null' googleMapsLink: description: A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' initialAdministrator: type: object properties: firstName: minLength: 1 maxLength: 255 type: string lastName: minLength: 1 maxLength: 255 type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string timezone: type: string gender: anyOf: - anyOf: - const: male type: string - const: female type: string - const: non-binary type: string - type: 'null' notifications: default: false type: boolean required: - firstName - lastName - email - timezone required: - name - type example: name: Minespider Germany GmbH type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f email: john@mail.com avatar: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 about: We enable you to be at the cutting-edge of sustainability. cahraArea: false streetAddress: Dunckerstrasse 79 city: Berlin country: DE brand: minespider phoneCountryCode: '+49' phoneAreaCode: '30' phoneNumber: '123456' registrationNumber: '123456' latitude: 52.543304 longitude: 13.421241 googleMapsLink: https://goo.gl/maps/7XARjBaCaWoJeqEA6 initialAdministrator: firstName: first-name lastName: last-name email: john@mail.com timezone: Europe/Lisbon gender: male notifications: false description: Request payload for Create a new managed entity. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a new managed entity. tags: - Tenant Entities /v1/tenancy/tenants/{tenant}/entities/{id}: get: description: >- Fetches the details of a specific entity managed by the tenant, based on the provided ID. operationId: EntityController_getOne parameters: - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant - name: id required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH features: '["BATTERY_PASSPORT"]' alias: minespider-germany-gmbh email: john@mail.com type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Producer alias: producer active: true createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true approved: true frozen: true cahraArea: false entityBlockchainAddress: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve managed entity by ID. tags: - Tenant Entities delete: description: >- Removes the specified tenant entity from the system based on the provided ID. operationId: EntityController_delete parameters: - name: id required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a provided tenant entity by ID. tags: - Tenant Entities /v1/tenancy/tenants/{tenant}/entities/{entity}/members: get: description: >- Fetches a collection of members associated with a specific tenant entity. operationId: MemberController_get parameters: - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant - name: entity required: true in: path schema: type: string description: Entity identifier. example: entity responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: {} '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve the collection of tenant entity's members. tags: - Tenant Members post: operationId: MemberController_create parameters: - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant - name: entity required: true in: path schema: type: string description: Entity identifier. example: entity - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create a passwordless member in a tenant-managed entity type: object properties: firstName: minLength: 1 maxLength: 255 type: string lastName: minLength: 1 maxLength: 255 type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string timezone: type: string gender: anyOf: - anyOf: - const: male type: string - const: female type: string - const: non-binary type: string - type: 'null' notifications: default: false type: boolean role: default: member anyOf: - const: admin type: string - const: member type: string required: - firstName - lastName - email - timezone example: firstName: first-name lastName: last-name email: john@mail.com timezone: Europe/Lisbon gender: male notifications: false role: member description: >- Request payload for Create a passwordless member in a tenant-managed entity. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: {} '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a passwordless member in a tenant-managed entity. tags: - Tenant Members /v1/tenancy/tenants/{tenant}/entities/{entity}/members/{id}: get: description: >- Fetches the details of a specific member associated with a tenant entity based on the provided criteria. operationId: TenancyMemberController_getOne parameters: - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant - name: entity required: true in: path schema: type: string description: Entity identifier. example: entity - name: id required: true in: path schema: type: string description: Member identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: {} '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve a tenant entity member. tags: - Tenant Members /v1/tenancy/tenants/{tenant}/entities/{entity}/members/{id}/impersonate: post: description: >- Impersonate an entity member by acquiring their access token. This endpoint returns a bearer access token used throughout the Minespider API, which does not have the usual expiration time. operationId: MemberController_impersonate parameters: - name: id required: true in: path schema: type: string description: Member identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entity required: true in: path schema: type: string description: Entity identifier. example: entity - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: {} '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Impersonate an entity member. tags: - Tenant Members /v1/entity/me: get: description: Retrieves profile data of the currently authenticated user. operationId: AppController_me parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: userId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string firstName: type: string lastName: type: string email: pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string emailVerified: type: boolean emailVerifiedAt: type: number admin: type: boolean active: type: boolean activatedAt: type: number lastLogin: type: number resetPasswordNextLogin: type: boolean createdAt: type: number createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string updatedAt: type: number updatedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: type: number deletedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - userId - firstName - lastName - email - emailVerified - admin - active - resetPasswordNextLogin - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: userId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f firstName: first-name lastName: last-name email: john@mail.com emailVerified: true admin: true active: true resetPasswordNextLogin: true createdAt: 0 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get current user information. tags: - Authentication - Users /v1/entity/entities/{entityId}/settings/tabs/overview: get: description: >- Fetches a summary of all available tabs in the system, providing an overview of their status or contents. operationId: TabController_getOverview parameters: - name: name required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Name value used by this operation. example: name - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true - name: alias required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Alias value used by this operation. example: alias - name: createdBy required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Created by value used by this operation. example: created-by - name: createdAt required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Filter by creation timestamp. example: created-at - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object example: type: object properties: all: description: The amount of tabs based on the query example: 10 type: number required: - all example: type: object properties: all: description: The amount of tabs based on the query example: 10 type: number required: - all '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve tabs overview. tags: - Tabs - Entity Settings /v1/entity/entities/{entityId}/settings/tabs: post: description: Allows users with the 'admin' role to create new tabs within the system. operationId: TabController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Tab creation body schema type: object properties: name: minLength: 3 description: Tab name example: Mines affairs type: string active: description: >- Status of activity. False means that this tab won't be shown on the product passport creation. example: false type: boolean properties: type: array items: description: Create tab property body schema type: object properties: title: minLength: 1 maxLength: 1000 description: Title of tab property example: Minery name type: string description: minLength: 1 maxLength: 10000 description: Description of tab property example: Provide minery name type: string type: minLength: 1 maxLength: 255 description: Tab property type example: checkboxGroup type: string required: description: Whether the tab property required or not example: false type: boolean order: minimum: 1 maximum: 255 description: Order of tab property example: 1 type: number group: description: Definition of tab property group example: checkBox type: string visibility: description: >- Visibility layer of tab property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string options: type: array items: description: Create tab property option body schema type: object properties: label: description: Label of tab property option example: Label type: string value: description: Value of tab property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 type: number required: - label - value - order required: - title - description - type - required - order - group - visibility - options required: - name example: name: Mines affairs active: false properties: - title: Minery name description: Provide minery name type: checkboxGroup required: false order: 1 group: checkBox visibility: public options: - label: Label value: Value order: -1 description: Request payload for Create a tab. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Tab type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab UUID name: description: Tab name example: Mines affairs type: string alias: description: 'Unique slugged alias of tab name ' example: mines-affairs type: string active: description: >- Status of activity. False means that this tab won't be shown on the product passport creation. example: false type: boolean scope: anyOf: - description: Tab scope example: BATTERY_PASSPORT type: string - type: 'null' ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tabs owner entity UUID properties: type: array items: description: Tab property type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property UUID visibility: description: >- Visibility layer of tab property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string key: description: Unique tab property key. Slugged value of title example: minery-name type: string order: description: Order of tab property example: 1 type: number title: description: Title of tab property example: Minery name type: string group: description: Definition of tab property group example: checkboxGroup type: string description: description: Description of tab property example: Provide minery name type: string required: description: Whether the tab property required or not example: false type: boolean type: description: Tab property type example: checkboxGroup type: string options: type: array items: description: Tab property option type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property option UUID label: description: Label of tab property option example: Label type: string value: description: Value of tab property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of tab property option example: 1 type: number required: - id - label - value - order createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - visibility - key - order - title - type - options - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - scope - ownedBy - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Mines affairs alias: mines-affairs active: false scope: BATTERY_PASSPORT ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a tab. tags: - Tabs - Entity Settings get: description: Fetches a collection of tabs based on the specified criteria or filters. operationId: TabController_findMany parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: order required: false in: query schema: minLength: 1 maxLength: 255 type: string default: '-active,-createdAt' description: Result ordering expression. example: '-active,-createdAt' - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true - name: alias required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Alias value used by this operation. example: alias - name: createdBy required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Created by value used by this operation. example: created-by - name: createdAt required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Filter by creation timestamp. example: created-at - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Tab type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab UUID name: description: Tab name example: Mines affairs type: string alias: description: 'Unique slugged alias of tab name ' example: mines-affairs type: string active: description: >- Status of activity. False means that this tab won't be shown on the product passport creation. example: false type: boolean scope: anyOf: - description: Tab scope example: BATTERY_PASSPORT type: string - type: 'null' ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tabs owner entity UUID properties: type: array items: description: Tab property type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property UUID visibility: description: >- Visibility layer of tab property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string key: description: >- Unique tab property key. Slugged value of title example: minery-name type: string order: description: Order of tab property example: 1 type: number title: description: Title of tab property example: Minery name type: string group: description: Definition of tab property group example: checkboxGroup type: string description: description: Description of tab property example: Provide minery name type: string required: description: Whether the tab property required or not example: false type: boolean type: description: Tab property type example: checkboxGroup type: string options: type: array items: description: Tab property option type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property option UUID label: description: Label of tab property option example: Label type: string value: description: Value of tab property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of tab property option example: 1 type: number required: - id - label - value - order createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - visibility - key - order - title - type - options - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - scope - ownedBy - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Mines affairs alias: mines-affairs active: false scope: BATTERY_PASSPORT ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve multiple tabs. tags: - Tabs - Entity Settings /v1/entity/entities/{entityId}/settings/tabs/{id}: get: description: Fetches the details of a specific tab based on the provided ID. operationId: TabController_findOne parameters: - name: id required: true in: path schema: type: string description: Tab identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Tab type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab UUID name: description: Tab name example: Mines affairs type: string alias: description: 'Unique slugged alias of tab name ' example: mines-affairs type: string active: description: >- Status of activity. False means that this tab won't be shown on the product passport creation. example: false type: boolean scope: anyOf: - description: Tab scope example: BATTERY_PASSPORT type: string - type: 'null' ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tabs owner entity UUID properties: type: array items: description: Tab property type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property UUID visibility: description: >- Visibility layer of tab property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string key: description: Unique tab property key. Slugged value of title example: minery-name type: string order: description: Order of tab property example: 1 type: number title: description: Title of tab property example: Minery name type: string group: description: Definition of tab property group example: checkboxGroup type: string description: description: Description of tab property example: Provide minery name type: string required: description: Whether the tab property required or not example: false type: boolean type: description: Tab property type example: checkboxGroup type: string options: type: array items: description: Tab property option type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property option UUID label: description: Label of tab property option example: Label type: string value: description: Value of tab property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of tab property option example: 1 type: number required: - id - label - value - order createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - visibility - key - order - title - type - options - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - scope - ownedBy - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Mines affairs alias: mines-affairs active: false scope: BATTERY_PASSPORT ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve tab by ID. tags: - Tabs - Entity Settings patch: description: >- Allows users with the 'admin' role to modify an existing tab in the system. operationId: TabController_update parameters: - name: id required: true in: path schema: type: string description: Tab identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: type: object properties: name: minLength: 3 description: Tab name example: Mines affairs type: string active: description: >- Status of activity. False means that this tab won't be shown on the product passport creation. example: false type: boolean properties: type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property UUID title: minLength: 1 maxLength: 1000 type: string description: minLength: 1 maxLength: 10000 type: string type: minLength: 1 maxLength: 255 type: string required: type: boolean order: minimum: 1 maximum: 255 type: number group: type: string visibility: anyOf: - const: transparent type: string - const: private type: string - const: public type: string options: type: array items: description: Tab property option edition body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property option UUID label: description: Label of tab property option example: Label type: string value: description: Value of tab property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 type: number required: - id - label - value - order minProperties: 1 description: Tab property edition body schema minProperties: 1 description: Tab edition body schema example: name: Mines affairs active: false properties: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f title: title description: description type: product-passport required: true order: 1 group: group visibility: transparent options: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f label: Label value: Value order: -1 description: Request payload for Edit a tab. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Tab type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab UUID name: description: Tab name example: Mines affairs type: string alias: description: 'Unique slugged alias of tab name ' example: mines-affairs type: string active: description: >- Status of activity. False means that this tab won't be shown on the product passport creation. example: false type: boolean scope: anyOf: - description: Tab scope example: BATTERY_PASSPORT type: string - type: 'null' ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tabs owner entity UUID properties: type: array items: description: Tab property type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property UUID visibility: description: >- Visibility layer of tab property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string key: description: Unique tab property key. Slugged value of title example: minery-name type: string order: description: Order of tab property example: 1 type: number title: description: Title of tab property example: Minery name type: string group: description: Definition of tab property group example: checkboxGroup type: string description: description: Description of tab property example: Provide minery name type: string required: description: Whether the tab property required or not example: false type: boolean type: description: Tab property type example: checkboxGroup type: string options: type: array items: description: Tab property option type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property option UUID label: description: Label of tab property option example: Label type: string value: description: Value of tab property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of tab property option example: 1 type: number required: - id - label - value - order createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - visibility - key - order - title - type - options - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - scope - ownedBy - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Mines affairs alias: mines-affairs active: false scope: BATTERY_PASSPORT ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Edit a tab. tags: - Tabs - Entity Settings delete: description: >- Allows users with the 'admin' role to delete an existing tab from the system. operationId: TabController_delete parameters: - name: id required: true in: path schema: type: string description: Tab identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a tab. tags: - Tabs - Entity Settings /v1/entity/entities/{entityId}/settings/tabs/{tab}/properties: post: description: >- Allows users with the 'admin' role to create new properties for tabs in the system. operationId: TabPropertyController_create parameters: - name: tab required: true in: path schema: type: string description: Tab identifier. example: tab - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Create tab property body schema type: object properties: title: minLength: 1 maxLength: 1000 description: Title of tab property example: Minery name type: string description: minLength: 1 maxLength: 10000 description: Description of tab property example: Provide minery name type: string type: minLength: 1 maxLength: 255 description: Tab property type example: checkboxGroup type: string required: description: Whether the tab property required or not example: false type: boolean order: minimum: 1 maximum: 255 description: Order of tab property example: 1 type: number group: description: Definition of tab property group example: checkBox type: string visibility: description: >- Visibility layer of tab property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string options: type: array items: description: Create tab property option body schema type: object properties: label: description: Label of tab property option example: Label type: string value: description: Value of tab property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 type: number required: - label - value - order required: - title - description - type - required - order - group - visibility - options example: title: Minery name description: Provide minery name type: checkboxGroup required: false order: 1 group: checkBox visibility: public options: - label: Label value: Value order: -1 description: Request payload for Create a tab property. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Tab property type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property UUID visibility: description: >- Visibility layer of tab property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string key: description: Unique tab property key. Slugged value of title example: minery-name type: string order: description: Order of tab property example: 1 type: number title: description: Title of tab property example: Minery name type: string group: description: Definition of tab property group example: checkboxGroup type: string description: description: Description of tab property example: Provide minery name type: string required: description: Whether the tab property required or not example: false type: boolean type: description: Tab property type example: checkboxGroup type: string options: type: array items: description: Tab property option type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property option UUID label: description: Label of tab property option example: Label type: string value: description: Value of tab property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of tab property option example: 1 type: number required: - id - label - value - order createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - visibility - key - order - title - type - options - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f visibility: public key: minery-name order: 1 title: Minery name type: checkboxGroup options: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f label: Label value: Value order: 1 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a tab property. tags: - Tabs - Entity Settings get: description: >- Fetches a collection of tab properties based on the specified criteria or filters. operationId: TabPropertyController_findMany parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: key required: false in: query schema: type: string description: Key value used by this operation. example: metadata.key - name: type required: false in: query schema: type: string description: Type value used by this operation. example: product-passport - name: title required: false in: query schema: type: string description: Title value used by this operation. example: title - name: required required: false in: query schema: type: boolean description: Required value used by this operation. example: true - name: visibility required: false in: query schema: anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: Visibility value used by this operation. example: transparent - name: order required: false in: query schema: type: string description: Result ordering expression. example: createdAt:desc - name: tab required: true in: path schema: type: string description: Tab identifier. example: tab - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve multiple tab properties. tags: - Tabs - Entity Settings /v1/entity/entities/{entityId}/settings/tabs/{tab}/properties/{id}: get: description: Fetches the details of a specific tab property based on the provided ID. operationId: TabPropertyController_findOne parameters: - name: id required: true in: path schema: type: string description: Property identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: tab required: true in: path schema: type: string description: Tab identifier. example: tab responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve tab property by ID. tags: - Tabs - Entity Settings patch: description: >- Allows users with the 'admin' role to modify an existing tab property in the system. operationId: TabPropertyController_update parameters: - name: id required: true in: path schema: type: string description: Property identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: tab required: true in: path schema: type: string description: Tab identifier. example: tab - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property UUID title: minLength: 1 maxLength: 1000 type: string description: minLength: 1 maxLength: 10000 type: string type: minLength: 1 maxLength: 255 type: string required: type: boolean order: minimum: 1 maximum: 255 type: number group: type: string visibility: anyOf: - const: transparent type: string - const: private type: string - const: public type: string options: type: array items: description: Tab property option edition body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property option UUID label: description: Label of tab property option example: Label type: string value: description: Value of tab property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 type: number required: - id - label - value - order minProperties: 1 description: Tab property edition body schema example: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f title: title description: description type: product-passport required: true order: 1 group: group visibility: transparent options: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f label: Label value: Value order: -1 description: Request payload for Edit a tab property. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Tab property type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property UUID visibility: description: >- Visibility layer of tab property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string key: description: Unique tab property key. Slugged value of title example: minery-name type: string order: description: Order of tab property example: 1 type: number title: description: Title of tab property example: Minery name type: string group: description: Definition of tab property group example: checkboxGroup type: string description: description: Description of tab property example: Provide minery name type: string required: description: Whether the tab property required or not example: false type: boolean type: description: Tab property type example: checkboxGroup type: string options: type: array items: description: Tab property option type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Tab property option UUID label: description: Label of tab property option example: Label type: string value: description: Value of tab property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of tab property option example: 1 type: number required: - id - label - value - order createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - visibility - key - order - title - type - options - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f visibility: public key: minery-name order: 1 title: Minery name type: checkboxGroup options: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f label: Label value: Value order: 1 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Edit a tab property. tags: - Tabs - Entity Settings delete: description: >- Allows users with the 'admin' role to delete an existing tab property from the system. operationId: TabPropertyController_delete parameters: - name: id required: true in: path schema: type: string description: Property identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: tab required: true in: path schema: type: string description: Tab identifier. example: tab - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a tab property. tags: - Tabs - Entity Settings /v1/notification/events: post: description: Adds a new event to the system with the provided details. operationId: EventController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create event body schema type: object properties: payload: {} entityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string type: anyOf: - const: ExternalDataRequest type: string - const: SendProductPassport type: string - const: ReceiveProductPassport type: string - const: ReceiveEntityCertificate type: string - const: PublishEntityCertificate type: string - const: PermissionRequest type: string - const: SendCertificate type: string - const: ReceiveCertificate type: string - const: Unknown type: string example: payload: payload entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f type: ExternalDataRequest description: Request payload for Create an event. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string entityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string recipientMemberId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string - type: 'null' type: anyOf: - const: ExternalDataRequest type: string - const: SendProductPassport type: string - const: ReceiveProductPassport type: string - const: ReceiveEntityCertificate type: string - const: PublishEntityCertificate type: string - const: PermissionRequest type: string - const: SendCertificate type: string - const: ReceiveCertificate type: string - const: Unknown type: string seen: default: false type: boolean delivered: default: false type: boolean processed: default: false type: boolean createdAt: anyOf: - type: number - type: integer payload: default: null required: - id - entityId - type - seen - delivered - processed - createdAt - payload required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f type: ExternalDataRequest seen: false delivered: false processed: false createdAt: 0 payload: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create an event. tags: - Notifications get: description: >- Fetches a collection of events based on the specified criteria or filters. operationId: EventController_find parameters: - name: seen required: false in: query schema: type: boolean description: Seen value used by this operation. example: true responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string entityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string recipientMemberId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string - type: 'null' type: anyOf: - const: ExternalDataRequest type: string - const: SendProductPassport type: string - const: ReceiveProductPassport type: string - const: ReceiveEntityCertificate type: string - const: PublishEntityCertificate type: string - const: PermissionRequest type: string - const: SendCertificate type: string - const: ReceiveCertificate type: string - const: Unknown type: string seen: default: false type: boolean delivered: default: false type: boolean processed: default: false type: boolean createdAt: anyOf: - type: number - type: integer payload: default: null required: - id - entityId - type - seen - delivered - processed - createdAt - payload required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f type: ExternalDataRequest seen: false delivered: false processed: false createdAt: 0 payload: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve events collection. tags: - Notifications /v1/notification/events/{id}: put: description: Modifies the details of an existing event in the system. operationId: EventController_update parameters: - name: id required: true in: path schema: type: string description: Event identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Update event body schema type: object properties: seen: type: boolean delivered: type: boolean example: seen: true delivered: true description: Request payload for Update an event. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string entityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string recipientMemberId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string - type: 'null' type: anyOf: - const: ExternalDataRequest type: string - const: SendProductPassport type: string - const: ReceiveProductPassport type: string - const: ReceiveEntityCertificate type: string - const: PublishEntityCertificate type: string - const: PermissionRequest type: string - const: SendCertificate type: string - const: ReceiveCertificate type: string - const: Unknown type: string seen: default: false type: boolean delivered: default: false type: boolean processed: default: false type: boolean createdAt: anyOf: - type: number - type: integer payload: default: null required: - id - entityId - type - seen - delivered - processed - createdAt - payload required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f type: ExternalDataRequest seen: false delivered: false processed: false createdAt: 0 payload: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Update an event. tags: - Notifications get: description: Fetches the details of a specific event based on the provided ID. operationId: EventController_findOne parameters: - name: id required: true in: path schema: type: string description: Event identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string entityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string recipientMemberId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string - type: 'null' type: anyOf: - const: ExternalDataRequest type: string - const: SendProductPassport type: string - const: ReceiveProductPassport type: string - const: ReceiveEntityCertificate type: string - const: PublishEntityCertificate type: string - const: PermissionRequest type: string - const: SendCertificate type: string - const: ReceiveCertificate type: string - const: Unknown type: string seen: default: false type: boolean delivered: default: false type: boolean processed: default: false type: boolean createdAt: anyOf: - type: number - type: integer payload: default: null required: - id - entityId - type - seen - delivered - processed - createdAt - payload required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f type: ExternalDataRequest seen: false delivered: false processed: false createdAt: 0 payload: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve event by ID. tags: - Notifications delete: description: Removes the specified event from the system. operationId: EventController_remove parameters: - name: id required: true in: path schema: type: string description: Event identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete an event. tags: - Notifications /v1/notification/unsubscribe: get: description: >- Disables email notifications for the user, preventing further email updates from the system. operationId: UnsubscribeController_unsubscribe parameters: - name: token required: true in: query schema: type: string description: Token value used by this operation. example: opaque-token responses: '200': description: Successful response. security: [] summary: Unsubscribe from email notifications. tags: - Notifications /v1/template/requests/standard: post: description: Submits a new request to the system with the provided details. operationId: RequestController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create standard request body schema type: object properties: name: description: Standard request name example: Standard minLength: 1 maxLength: 255 type: string required: - name example: name: Standard description: Request payload for Create a request. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard request UUID name: description: Standard request name example: Standard type: string alias: description: Unique slugged value of standard request name example: standard type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard request owner UUID status: description: >- Standard request status. Possible values: requested, implemented, rejected anyOf: - const: requested type: string - const: implemented type: string - const: rejected type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - name - alias - ownedBy - status - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: name: Standard alias: standard ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: requested createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a request. tags: - Template Requests get: description: >- Fetches a collection of requests based on the specified criteria or filters. operationId: RequestController_findMany parameters: - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: name required: false in: query schema: minLength: 0 maxLength: 255 description: Standard request name example: Standard type: string description: Standard request name example: Standard - name: alias required: false in: query schema: minLength: 0 maxLength: 255 description: Unique slugged value of standard request name example: standard type: string description: Unique slugged value of standard request name example: standard - name: status required: false in: query schema: description: >- Standard request status. Possible values: requested, implemented, rejected anyOf: - const: requested type: string - const: implemented type: string - const: rejected type: string description: >- Standard request status. Possible values: requested, implemented, rejected example: requested responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard request UUID name: description: Standard request name example: Standard type: string alias: description: Unique slugged value of standard request name example: standard type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard request owner UUID status: description: >- Standard request status. Possible values: requested, implemented, rejected anyOf: - const: requested type: string - const: implemented type: string - const: rejected type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - name - alias - ownedBy - status - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - name: Standard alias: standard ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: requested createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve multiple requests. tags: - Template Requests /v1/template/requests/standard/{id}: get: description: Fetches the details of a specific request based on the provided ID. operationId: RequestController_findOne parameters: - name: id required: true in: path schema: type: string description: Standard identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard request UUID name: description: Standard request name example: Standard type: string alias: description: Unique slugged value of standard request name example: standard type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard request owner UUID status: description: >- Standard request status. Possible values: requested, implemented, rejected anyOf: - const: requested type: string - const: implemented type: string - const: rejected type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - name - alias - ownedBy - status - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: name: Standard alias: standard ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: requested createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve request by ID. tags: - Template Requests patch: description: Modifies the details of an existing request in the system. operationId: RequestController_update parameters: - name: id required: true in: path schema: type: string description: Standard identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create standard request body schema type: object properties: name: description: Standard request name example: Standard minLength: 1 maxLength: 255 type: string required: - name example: name: Standard description: Request payload for Edit a request. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard request UUID name: description: Standard request name example: Standard type: string alias: description: Unique slugged value of standard request name example: standard type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard request owner UUID status: description: >- Standard request status. Possible values: requested, implemented, rejected anyOf: - const: requested type: string - const: implemented type: string - const: rejected type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - name - alias - ownedBy - status - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: name: Standard alias: standard ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: requested createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Edit a request. tags: - Template Requests delete: description: Removes the specified request from the system. operationId: RequestController_delete parameters: - name: id required: true in: path schema: type: string description: Standard identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a request. tags: - Template Requests /v1/template/standards: post: description: Allows root entity members to create new standards in the system. operationId: StandardController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Standard creation body schema default: active: true type: object properties: name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean properties: type: array items: description: Standard property creation body schema type: object properties: title: minLength: 1 maxLength: 1000 description: Title of standard property example: Minery name type: string type: minLength: 1 maxLength: 255 description: Standard property type example: checkboxGroup type: string visibility: description: >- Visibility layer of standard property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string order: minimum: 0 description: Order of standard property example: 1 type: number required: description: Whether the standard property required or not example: false type: boolean description: minLength: 1 maxLength: 10000 description: Description of standard property example: Provide minery name type: string group: description: Definition of standard property group example: checkboxGroup type: string const: anyOf: - type: string - type: number - type: boolean format: type: string minimum: type: number maximum: type: number minLength: type: number maxLength: type: number options: type: array items: description: Standard property option creation body schema type: object properties: label: description: Label of standard property option example: Label type: string value: description: Value of standard property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of standard property option example: 1 type: number required: - label - value - order required: - title - type - visibility required: - name example: name: Test template active: true properties: - title: Minery name type: checkboxGroup visibility: public order: 1 required: false description: Provide minery name group: checkboxGroup const: const format: format minimum: 0 maximum: 0 minLength: 0 maxLength: 0 options: - label: Label value: Value order: 1 description: Request payload for Create a standard. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a standard. tags: - Template Standards get: description: >- Fetches a collection of standards based on the specified criteria or filters. operationId: StandardController_findMany parameters: - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: name required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Name value used by this operation. example: name - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true - name: alias required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Alias value used by this operation. example: alias - name: createdBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Created by value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: createdAt required: false in: query schema: type: string description: Filter by creation timestamp. example: created-at responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve multiple standards. tags: - Template Standards /v1/template/standards/{id}: get: description: Fetches the details of a specific standard based on the provided ID. operationId: StandardController_findOne parameters: - name: id required: true in: path schema: type: string description: Standard identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Find standard by ID. tags: - Template Standards patch: description: Allows root entity members to modify existing standards in the system. operationId: StandardController_update parameters: - name: id required: true in: path schema: type: string description: Standard identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Standard updation body schema type: object properties: name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean example: name: Test template active: true description: Request payload for Edit a standard. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Edit a standard. tags: - Template Standards delete: description: >- Allows root entity members to delete an existing standard from the system. operationId: StandardController_delete parameters: - name: id required: true in: path schema: type: string description: Standard identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a standard. tags: - Template Standards /v1/template/standards/{standard}/properties: post: description: >- Allows root entity members to create new standard properties in the system. operationId: StandardPropertyController_create parameters: - name: standard required: true in: path schema: type: string description: Standard identifier. example: standard - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Standard property creation body schema type: object properties: title: minLength: 1 maxLength: 1000 description: Title of standard property example: Minery name type: string type: minLength: 1 maxLength: 255 description: Standard property type example: checkboxGroup type: string visibility: description: >- Visibility layer of standard property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string order: minimum: 0 description: Order of standard property example: 1 type: number required: description: Whether the standard property required or not example: false type: boolean description: minLength: 1 maxLength: 10000 description: Description of standard property example: Provide minery name type: string group: description: Definition of standard property group example: checkboxGroup type: string const: anyOf: - type: string - type: number - type: boolean format: type: string minimum: type: number maximum: type: number minLength: type: number maxLength: type: number options: type: array items: description: Standard property option creation body schema type: object properties: label: description: Label of standard property option example: Label type: string value: description: Value of standard property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of standard property option example: 1 type: number required: - label - value - order required: - title - type - visibility example: title: Minery name type: checkboxGroup visibility: public order: 1 required: false description: Provide minery name group: checkboxGroup const: const format: format minimum: 0 maximum: 0 minLength: 0 maxLength: 0 options: - label: Label value: Value order: 1 description: Request payload for Create a standard property. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Standard property type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard property UUID title: minLength: 1 maxLength: 1000 description: Title of standard property example: Minery name type: string description: minLength: 1 maxLength: 10000 description: Description of standard property example: Provide minery name type: string type: minLength: 1 maxLength: 255 description: Standard property type example: checkboxGroup type: string required: description: Whether the standard property required or not example: false type: boolean key: minLength: 1 maxLength: 255 description: Unique standard property key. Slugged value of title example: minery-name type: string order: minimum: 0 description: Order of standard property example: 1 type: number group: description: Definition of standard property group example: checkboxGroup type: string const: anyOf: - type: string - type: number - type: boolean format: type: string minimum: type: number maximum: type: number minLength: type: number maxLength: type: number options: type: array items: description: Standard property option type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard property option UUID label: description: Label of standard property option example: Label type: string value: description: Value of standard property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of standard property option example: 1 type: number required: - id - label - value - order visibility: description: >- Visibility layer of standard property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - title - type - key - order - visibility - standard - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f title: Minery name type: checkboxGroup key: minery-name order: 1 visibility: public standard: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a standard property. tags: - Template Properties get: description: >- Fetches a collection of standard properties based on the specified criteria or filters. operationId: StandardPropertyController_findMany parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: key required: false in: query schema: minLength: 1 maxLength: 255 description: Unique standard property key. Slugged value of title example: minery-name type: string description: Unique standard property key. Slugged value of title example: minery-name - name: type required: false in: query schema: minLength: 1 maxLength: 255 description: Standard property type example: checkboxGroup type: string description: Standard property type example: checkboxGroup - name: format required: false in: query schema: minLength: 1 maxLength: 255 type: string description: Format value used by this operation. example: format - name: title required: false in: query schema: minLength: 1 maxLength: 1000 description: Title of standard property example: Minery name type: string description: Title of standard property example: Minery name - name: required required: false in: query schema: description: Whether the standard property required or not example: false type: boolean description: Whether the standard property required or not example: false - name: visibility required: false in: query schema: anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: Visibility value used by this operation. example: transparent - name: order required: false in: query schema: default: '-createdAt' description: Order to sort results type: string description: Order to sort results example: '-createdAt' - name: standard required: true in: path schema: type: string description: Standard identifier. example: standard responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Standard property type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard property UUID title: minLength: 1 maxLength: 1000 description: Title of standard property example: Minery name type: string description: minLength: 1 maxLength: 10000 description: Description of standard property example: Provide minery name type: string type: minLength: 1 maxLength: 255 description: Standard property type example: checkboxGroup type: string required: description: Whether the standard property required or not example: false type: boolean key: minLength: 1 maxLength: 255 description: Unique standard property key. Slugged value of title example: minery-name type: string order: minimum: 0 description: Order of standard property example: 1 type: number group: description: Definition of standard property group example: checkboxGroup type: string const: anyOf: - type: string - type: number - type: boolean format: type: string minimum: type: number maximum: type: number minLength: type: number maxLength: type: number options: type: array items: description: Standard property option type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard property option UUID label: description: Label of standard property option example: Label type: string value: description: Value of standard property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of standard property option example: 1 type: number required: - id - label - value - order visibility: description: >- Visibility layer of standard property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - title - type - key - order - visibility - standard - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f title: Minery name type: checkboxGroup key: minery-name order: 1 visibility: public standard: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve multiple standard properties. tags: - Template Properties /v1/template/standards/{standard}/properties/{id}: get: description: >- Fetches the details of a specific standard property based on the provided ID. operationId: StandardPropertyController_findOne parameters: - name: id required: true in: path schema: type: string description: Property identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: standard required: true in: path schema: type: string description: Standard identifier. example: standard responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve standard property by ID. tags: - Template Properties patch: description: >- Allows root entity members to modify existing standard properties in the system. operationId: StandardPropertyController_update parameters: - name: id required: true in: path schema: type: string description: Property identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: standard required: true in: path schema: type: string description: Standard identifier. example: standard - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: minProperties: 1 description: Standard property updation body schema type: object properties: title: minLength: 1 maxLength: 1000 description: Title of standard property example: Minery name type: string type: minLength: 1 maxLength: 255 description: Standard property type example: checkboxGroup type: string visibility: description: >- Visibility layer of standard property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string order: minimum: 0 description: Order of standard property example: 1 type: number required: description: Whether the standard property required or not example: false type: boolean description: minLength: 1 maxLength: 10000 description: Description of standard property example: Provide minery name type: string group: description: Definition of standard property group example: checkboxGroup type: string const: anyOf: - type: string - type: number - type: boolean format: type: string minimum: type: number maximum: type: number minLength: type: number maxLength: type: number options: type: array items: description: Standard property option updation body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard property option UUID label: description: Label of standard property option example: Label type: string value: description: Value of standard property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of standard property option example: 1 type: number required: - id - label - value - order createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string example: title: Minery name type: checkboxGroup visibility: public order: 1 required: false description: Provide minery name group: checkboxGroup const: const format: format minimum: 0 maximum: 0 minLength: 0 maxLength: 0 options: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f label: Label value: Value order: 1 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f updatedAt: null updatedBy: null deletedAt: null deletedBy: null description: Request payload for Edit a standard property. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Standard property type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard property UUID title: minLength: 1 maxLength: 1000 description: Title of standard property example: Minery name type: string description: minLength: 1 maxLength: 10000 description: Description of standard property example: Provide minery name type: string type: minLength: 1 maxLength: 255 description: Standard property type example: checkboxGroup type: string required: description: Whether the standard property required or not example: false type: boolean key: minLength: 1 maxLength: 255 description: Unique standard property key. Slugged value of title example: minery-name type: string order: minimum: 0 description: Order of standard property example: 1 type: number group: description: Definition of standard property group example: checkboxGroup type: string const: anyOf: - type: string - type: number - type: boolean format: type: string minimum: type: number maximum: type: number minLength: type: number maxLength: type: number options: type: array items: description: Standard property option type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard property option UUID label: description: Label of standard property option example: Label type: string value: description: Value of standard property option example: Value type: string order: default: -1 minimum: -1 maximum: 255 description: Order of standard property option example: 1 type: number required: - id - label - value - order visibility: description: >- Visibility layer of standard property. Possible values: public, transparent, private example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - title - type - key - order - visibility - standard - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f title: Minery name type: checkboxGroup key: minery-name order: 1 visibility: public standard: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Edit a standard property. tags: - Template Properties delete: description: >- Allows root entity members to delete an existing standard property from the system. operationId: StandardPropertyController_delete parameters: - name: id required: true in: path schema: type: string description: Property identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: standard required: true in: path schema: type: string description: Standard identifier. example: standard - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '204': description: Request completed successfully with no response body. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a standard property. tags: - Template Properties /v1/template/analytics/standard/requests: get: description: >- Fetches detailed analytics regarding the system's requests, including usage patterns, request counts, and response times. operationId: AnalyticsController_getRequests parameters: - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: name: type: string alias: type: string amount: type: number lastRequested: type: number status: anyOf: - const: requested type: string - const: implemented type: string - const: rejected type: string required: - name - alias - amount - lastRequested - status required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: name: name alias: alias amount: 0 lastRequested: 0 status: requested '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve requests analytics. tags: - Template Analytics /v1/template/analytics/standard/overview: get: description: >- Provides a summary of the analytics for templates, including usage statistics and performance data. operationId: AnalyticsController_getOverview parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: all: type: number requests: type: number requested: type: number new: type: number required: - all - requests - requested - new required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: all: 0 requests: 0 requested: 0 new: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve template analytics overview. tags: - Template Analytics /v1/template/templates: post: description: Allows entity members to create new templates in the system. operationId: TemplateController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Template creation body schema default: active: true type: object properties: name: minLength: 1 maxLength: 255 description: Template name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean type: anyOf: - const: ProductPassport type: string - const: BatteryPassport type: string - const: PVPassport type: string - const: SimplifiedPVPassport type: string - const: BatchPassport type: string - const: MaterialPassport type: string - const: TyrePassport type: string - const: EntityCertificate type: string schema: description: Template JSON schema status: anyOf: - const: draft type: string - const: published type: string - const: deprecated type: string required: - name - type - schema example: name: Test template active: true type: ProductPassport schema: schema status: draft description: Request payload for Create a template. responses: '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Template type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Template UUID name: minLength: 1 maxLength: 255 description: Template name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a template example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of template's owner status: description: Status of the template example: draft anyOf: - const: draft type: string - const: published type: string - const: deprecated type: string schema: description: Template JSON schema createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - status - schema - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 201 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: draft schema: schema createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a template. tags: - Templates get: description: Allows entity members to retrieve all templates available in the system. operationId: TemplateController_getAll parameters: - name: order required: false in: query schema: default: '-updatedAt' type: string description: Result ordering expression. example: '-updatedAt' - name: type required: false in: query schema: type: string description: Type value used by this operation. example: product-passport - name: default required: false in: query schema: type: boolean description: Default value used by this operation. example: true - name: active required: false in: query schema: type: boolean description: Filter by active state. example: true - name: status required: false in: query schema: default: draft,published type: string description: Filter by lifecycle status. example: draft,published - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Template type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Template UUID name: minLength: 1 maxLength: 255 description: Template name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a template example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of template's owner status: description: Status of the template example: draft anyOf: - const: draft type: string - const: published type: string - const: deprecated type: string schema: description: Template JSON schema createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - status - schema - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: draft schema: schema createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: - {} - bearer: [] - cookie: [] summary: Get all templates. tags: - Templates /v1/template/templates/{id}: patch: description: Allows entity members to update existing templates in the system. operationId: TemplateController_update parameters: - name: id required: true in: path schema: type: string description: Template identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Template editing body schema type: object properties: name: minLength: 1 maxLength: 255 description: Template name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean schema: description: Template JSON schema status: anyOf: - const: draft type: string - const: published type: string - const: deprecated type: string example: name: Test template active: true schema: schema status: draft description: Request payload for Update a template. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Template type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Template UUID name: minLength: 1 maxLength: 255 description: Template name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a template example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of template's owner status: description: Status of the template example: draft anyOf: - const: draft type: string - const: published type: string - const: deprecated type: string schema: description: Template JSON schema createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - status - schema - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: draft schema: schema createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Template type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Template UUID name: minLength: 1 maxLength: 255 description: Template name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a template example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of template's owner status: description: Status of the template example: draft anyOf: - const: draft type: string - const: published type: string - const: deprecated type: string schema: description: Template JSON schema createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - status - schema - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 201 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: draft schema: schema createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Update a template. tags: - Templates delete: description: Allows entity members to delete existing templates in the system. operationId: TemplateController_delete parameters: - name: id required: true in: path schema: type: string description: Template identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '204': description: Template deleted successfully. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a template. tags: - Templates get: description: Allows entity members to retrieve a specific template by its ID. operationId: TemplateController_getById parameters: - name: id required: true in: path schema: type: string description: Template identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Template type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Template UUID name: minLength: 1 maxLength: 255 description: Template name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a template example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of template's owner status: description: Status of the template example: draft anyOf: - const: draft type: string - const: published type: string - const: deprecated type: string schema: description: Template JSON schema createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - status - schema - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: draft schema: schema createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get a template by ID. tags: - Templates /v1/template/templates/generate: get: description: Gets the import template for Battery Passports. operationId: TemplateController_export parameters: - name: type required: true in: query schema: enum: - product-passport - entity - battery-passport - pv-passport - simplified-pv-passport - batch-passport - material-passport - tyre-passport type: string description: Type value used by this operation. example: product-passport responses: '200': description: XLSX import template file content: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get import template. tags: - Templates /v1/template/templates/{id}/latest: get: description: >- Allows entity members to retrieve a latest version of a template by its ID. operationId: TemplateController_getLatest parameters: - name: id required: true in: path schema: type: string description: Template identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Template type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Template UUID name: minLength: 1 maxLength: 255 description: Template name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a template example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of template's owner status: description: Status of the template example: draft anyOf: - const: draft type: string - const: published type: string - const: deprecated type: string schema: description: Template JSON schema createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - status - schema - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: draft schema: schema createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get latest version of a template by ID. tags: - Templates /v1/template/templates/{id}/history: get: description: >- Allows entity members to retrieve all version of a specific template by its ID. operationId: TemplateController_getHistory parameters: - name: id required: true in: path schema: type: string description: Template identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Template type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Template UUID name: minLength: 1 maxLength: 255 description: Template name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a template example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of template's owner status: description: Status of the template example: draft anyOf: - const: draft type: string - const: published type: string - const: deprecated type: string schema: description: Template JSON schema createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - status - schema - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: draft schema: schema createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get template history by ID. tags: - Templates /v1/template/templates/{id}/publish: post: description: >- Allows entity members to publish a draft template, making it available for use. operationId: TemplateController_publish parameters: - name: id required: true in: path schema: type: string description: Template identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Template type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Template UUID name: minLength: 1 maxLength: 255 description: Template name example: Test template type: string active: default: true description: Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a template example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of template's owner status: description: Status of the template example: draft anyOf: - const: draft type: string - const: published type: string - const: deprecated type: string schema: description: Template JSON schema createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - status - schema - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Test template active: true alias: test-template ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: draft schema: schema createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Publish a template. tags: - Templates /v1/supply-chain/measurements/units/{id}: get: description: Retrieves a specific measurement unit using its unique identifier. operationId: MeasurementUnitController_findOne parameters: - name: id required: true in: path schema: type: string description: Unit identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Measurement unit type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement unit UUID name: description: Measurement unit name example: Liter type: string symbol: description: Measurement unit symbol example: l type: string active: description: Whether measurement unit is active or not example: true type: boolean default: description: Whether measurement unit is default or not example: true type: boolean type: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - symbol - active - default - type - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liter symbol: l active: true default: true type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: [] summary: Get measurement unit by id. tags: - Measurement Units /v1/supply-chain/measurements/units: get: description: Fetches a collection of all available measurement units in the system. operationId: MeasurementUnitController_find parameters: - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true - name: createdBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement unit creators UUID description: Measurement unit creators UUID example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Measurement unit type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement unit UUID name: description: Measurement unit name example: Liter type: string symbol: description: Measurement unit symbol example: l type: string active: description: Whether measurement unit is active or not example: true type: boolean default: description: Whether measurement unit is default or not example: true type: boolean type: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - symbol - active - default - type - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liter symbol: l active: true default: true type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve measurement units collection. tags: - Measurement Units /v1/supply-chain/measurements/types: get: description: Fetches a collection of all available measurement types in the system. operationId: MeasurementTypeController_find parameters: - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true - name: createdBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type creators UUID description: Measurement type creators UUID example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve a measurement types collection. tags: - Measurement Types /v1/supply-chain/measurements/types/{id}: get: description: Retrieves a specific measurement type using its unique identifier. operationId: MeasurementTypeController_findOne parameters: - name: id required: true in: path schema: type: string description: Type identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: [] summary: Get measurement type by id. tags: - Measurement Types /v1/back-office/feature-flags: get: description: >- Lists platform feature-flag definitions for root administration, with filtering and pagination. operationId: FeatureFlagController_list parameters: - name: name required: false in: query schema: description: Filter by name (contains) type: string description: Filter by name (contains) example: name - name: key required: false in: query schema: description: Filter by key (contains) type: string description: Filter by key (contains) example: metadata.key - name: default required: false in: query schema: description: Filter by default enabled state type: boolean description: Filter by default enabled state example: true - name: order required: false in: query schema: description: Sort order, prefix '-' for descending (e.g. 'name' or '-name') type: string description: Sort order, prefix '-' for descending (e.g. 'name' or '-name') example: createdAt:desc - name: search required: false in: query schema: description: Filter by feature key or name type: string description: Filter by feature key or name example: battery responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Paginated feature flags type: object properties: total: type: number rows: type: array items: description: Feature flag DTO type: object properties: id: type: string key: type: string name: type: string description: type: string default: type: boolean createdAt: type: number createdBy: type: string updatedAt: type: number updatedBy: type: string required: - id - key - name - default - createdAt - createdBy required: - total - rows required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: total: 0 rows: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key name: name default: true createdAt: 0 createdBy: created-by '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: List feature flags tags: - Feature Flags post: description: >- Creates a platform feature-flag definition. This operation is restricted to root administrators. operationId: FeatureFlagController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create feature flag payload type: object properties: key: description: Unique key for the feature flag type: string name: description: Human friendly name type: string description: description: Optional description type: string default: description: Default enabled state for the flag type: boolean required: - key - name example: key: metadata.key name: name description: description default: true description: Request payload for Create a feature flag responses: '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Feature flag DTO type: object properties: id: type: string key: type: string name: type: string description: type: string default: type: boolean createdAt: type: number createdBy: type: string updatedAt: type: number updatedBy: type: string required: - id - key - name - default - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 201 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key name: name default: true createdAt: 0 createdBy: created-by '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a feature flag tags: - Feature Flags /v1/back-office/feature-flags/entities: get: description: >- Lists entity-specific feature-flag overrides for root administration, with filtering and pagination. operationId: FeatureFlagController_entityOverrides parameters: - name: entityId required: false in: query schema: description: Filter by entity id type: string description: Filter by entity id example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: featureFlagId required: false in: query schema: description: Filter by feature flag id type: string description: Filter by feature flag id example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: enabled required: false in: query schema: description: Filter by enabled state type: boolean description: Filter by enabled state example: true - name: order required: false in: query schema: description: >- Sort order, prefix '-' for descending (e.g. 'featureFlag.name' or '-enabled') type: string description: >- Sort order, prefix '-' for descending (e.g. 'featureFlag.name' or '-enabled') example: createdAt:desc responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Paginated entity feature flag overrides type: object properties: total: type: number rows: type: array items: description: Entity feature flag override DTO type: object properties: id: type: string entityId: type: string featureFlagId: type: string enabled: type: boolean createdAt: type: number createdBy: type: string updatedAt: type: number updatedBy: type: string featureFlag: description: Feature flag DTO type: object properties: id: type: string key: type: string name: type: string description: type: string default: type: boolean createdAt: type: number createdBy: type: string updatedAt: type: number updatedBy: type: string required: - id - key - name - default - createdAt - createdBy required: - id - entityId - featureFlagId - enabled - createdAt - createdBy - featureFlag required: - total - rows required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: total: 0 rows: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f featureFlagId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f enabled: true createdAt: 0 createdBy: created-by featureFlag: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key name: name default: true createdAt: 0 createdBy: created-by '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get entity feature flag overrides tags: - Feature Flags /v1/back-office/feature-flags/{id}: patch: description: Updates the mutable fields of a platform feature-flag definition. operationId: FeatureFlagController_patch parameters: - name: id required: true in: path schema: type: string description: Feature flag identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Update feature flag payload type: object properties: name: description: Human friendly name type: string description: description: Optional description type: string default: description: Default enabled state for the flag type: boolean example: name: name description: description default: true description: Request payload for Update a feature flag responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Feature flag DTO type: object properties: id: type: string key: type: string name: type: string description: type: string default: type: boolean createdAt: type: number createdBy: type: string updatedAt: type: number updatedBy: type: string required: - id - key - name - default - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key name: name default: true createdAt: 0 createdBy: created-by '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Update a feature flag tags: - Feature Flags delete: description: Deletes a platform feature-flag definition and returns no response body. operationId: FeatureFlagController_remove parameters: - name: id required: true in: path schema: type: string description: Feature flag identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '204': description: Request completed successfully with no response body. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a feature flag tags: - Feature Flags /v1/back-office/feature-flags/{entityId}/{featureId}/on: post: description: >- Creates or updates an entity override that explicitly enables the selected feature. operationId: FeatureFlagController_enableForEntity parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: featureId required: true in: path schema: type: string description: Feature identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Entity feature flag override DTO type: object properties: id: type: string entityId: type: string featureFlagId: type: string enabled: type: boolean createdAt: type: number createdBy: type: string updatedAt: type: number updatedBy: type: string featureFlag: description: Feature flag DTO type: object properties: id: type: string key: type: string name: type: string description: type: string default: type: boolean createdAt: type: number createdBy: type: string updatedAt: type: number updatedBy: type: string required: - id - key - name - default - createdAt - createdBy required: - id - entityId - featureFlagId - enabled - createdAt - createdBy - featureFlag required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f featureFlagId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f enabled: true createdAt: 0 createdBy: created-by featureFlag: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key name: name default: true createdAt: 0 createdBy: created-by '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Enable a feature for an entity tags: - Feature Flags /v1/back-office/feature-flags/{entityId}/{featureId}/off: post: description: >- Creates or updates an entity override that explicitly disables the selected feature. operationId: FeatureFlagController_disableForEntity parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: featureId required: true in: path schema: type: string description: Feature identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Entity feature flag override DTO type: object properties: id: type: string entityId: type: string featureFlagId: type: string enabled: type: boolean createdAt: type: number createdBy: type: string updatedAt: type: number updatedBy: type: string featureFlag: description: Feature flag DTO type: object properties: id: type: string key: type: string name: type: string description: type: string default: type: boolean createdAt: type: number createdBy: type: string updatedAt: type: number updatedBy: type: string required: - id - key - name - default - createdAt - createdBy required: - id - entityId - featureFlagId - enabled - createdAt - createdBy - featureFlag required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f featureFlagId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f enabled: true createdAt: 0 createdBy: created-by featureFlag: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key name: name default: true createdAt: 0 createdBy: created-by '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Disable a feature for an entity tags: - Feature Flags /v1/back-office/feature-flags/{entityId}/{featureId}: delete: description: >- Removes the entity-specific override so the feature uses its platform-level configuration. operationId: FeatureFlagController_deleteForEntity parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: featureId required: true in: path schema: type: string description: Feature identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '204': description: Request completed successfully with no response body. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Remove a feature override for an entity tags: - Feature Flags /v1/back-office/entity-limits: get: description: >- Lists explicit per-entity user limits, optionally filtered by entity ID. Root access is required. operationId: EntityLimitController_list parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: entityId: type: string value: anyOf: - type: integer - type: 'null' required: - entityId - value required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f value: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: List configured maximum-user limits tags: - Entity Limits /v1/back-office/entity-limits/maximum-evidence-file-size: get: description: >- Lists explicit per-entity evidence file-size limits, optionally filtered by entity ID. operationId: EntityLimitController_listMaximumEvidenceFileSizes parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: technicalMaximum: type: integer limits: type: array items: type: object properties: entityId: type: string value: type: integer required: - entityId - value required: - technicalMaximum - limits required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: technicalMaximum: 0 limits: - entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f value: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: List configured maximum evidence-file-size limits tags: - Entity Limits /v1/back-office/entity-limits/maximum-evidence-storage: get: description: >- Lists explicit per-entity evidence storage limits, optionally filtered by entity ID. operationId: EntityLimitController_listMaximumEvidenceStorage parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: entityId: type: string value: anyOf: - type: integer - type: 'null' required: - entityId - value required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f value: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: List configured maximum evidence-storage limits tags: - Entity Limits /v1/back-office/entity-limits/{entityId}/maximum-users: put: description: >- Creates or replaces the maximum number of users allowed for the selected entity. operationId: EntityLimitController_setMaximumUsers parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: value: anyOf: - minimum: 1 maximum: 2147483647 type: integer - type: 'null' required: - value example: value: 1 description: Request payload for Set an entity maximum-user limit responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: entityId: type: string value: anyOf: - type: integer - type: 'null' required: - entityId - value required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f value: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Set an entity maximum-user limit tags: - Entity Limits /v1/back-office/entity-limits/{entityId}/maximum-evidence-storage: put: description: >- Creates or replaces the total evidence storage limit, in bytes, for the selected entity. operationId: EntityLimitController_setMaximumEvidenceStorage parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: value: anyOf: - minimum: 1 maximum: 9007199254740991 type: integer - type: 'null' required: - value example: value: 1 description: Request payload for Set an entity maximum evidence-storage limit responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: entityId: type: string value: anyOf: - type: integer - type: 'null' required: - entityId - value required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f value: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Set an entity maximum evidence-storage limit tags: - Entity Limits /v1/back-office/entity-limits/{entityId}/maximum-evidence-file-size: put: description: >- Creates or replaces the maximum individual evidence file size, in bytes, for the selected entity. operationId: EntityLimitController_setMaximumEvidenceFileSize parameters: - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: value: minimum: 1 type: integer required: - value example: value: 1 description: Request payload for Set an entity maximum evidence-file-size limit responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: entityId: type: string value: type: integer required: - entityId - value required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f value: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Set an entity maximum evidence-file-size limit tags: - Entity Limits /v1/back-office/entity-controls/batch: post: description: >- Queues the requested entity-control changes and returns a job ID for status polling. operationId: EntityControlBatchController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false type: object properties: entityIds: minItems: 1 maxItems: 100 uniqueItems: true type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID featureOverrides: minItems: 1 maxItems: 100 type: array items: additionalProperties: false type: object properties: featureFlagId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID enabled: type: boolean required: - featureFlagId - enabled limits: additionalProperties: false type: object properties: maximumUsers: anyOf: - minimum: 1 maximum: 2147483647 type: integer - type: 'null' maximumEvidenceStorage: anyOf: - minimum: 1 maximum: 9007199254740991 type: integer - type: 'null' maximumEvidenceFileSize: minimum: 1 maximum: 9007199254740991 type: integer required: - maximumUsers - maximumEvidenceStorage - maximumEvidenceFileSize required: - entityIds - featureOverrides - limits example: entityIds: - 4ac55d01-ec52-499e-9bc3-b5d648ffd88f featureOverrides: - featureFlagId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f enabled: true limits: maximumUsers: 1 maximumEvidenceStorage: 1 maximumEvidenceFileSize: 1 description: Request payload for Create an asynchronous entity-control batch job responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: jobId: type: string queue: type: string total: type: number required: - jobId - total required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: jobId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f total: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create an asynchronous entity-control batch job tags: - Entity Control Batch /v1/back-office/entity-controls/batch/{jobId}/status: get: description: >- Returns progress and item-level results for a batch job created by the requesting root user. operationId: EntityControlBatchController_status parameters: - name: jobId required: true in: path schema: type: string description: Job identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: type: string state: anyOf: - const: active type: string - const: completed type: string - const: delayed type: string - const: failed type: string - const: paused type: string - const: prioritized type: string - const: waiting type: string - const: waiting-children type: string - const: unknown type: string progress: type: number attemptsMade: type: number timestamp: type: number processedOn: anyOf: - type: number - type: 'null' finishedOn: anyOf: - type: number - type: 'null' returnValue: anyOf: - type: object properties: total: type: number successCount: type: number failedCount: type: number successList: type: array items: type: object properties: index: type: number entityId: type: string required: - index - entityId errorList: type: array items: type: object properties: index: type: number entityId: type: string error: type: string statusCode: type: number required: - index - entityId - error required: - total - successCount - failedCount - successList - errorList - type: 'null' failedReason: type: string required: - id - state - progress - attemptsMade - timestamp required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f state: active progress: 0 attemptsMade: 0 timestamp: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get an entity-control batch job status tags: - Entity Control Batch /v1/supply-chain/certificates/layer-acl: get: description: >- Retrieves the access control list (ACL) for a certificate, grouped by relevant permissions or entities. operationId: LayerAclGetRouteController_getGrouped parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: grantee required: false in: query schema: type: string description: Grantee value used by this operation. example: grantee - name: granter required: false in: query schema: type: string description: Granter value used by this operation. example: granter - name: layer required: false in: query schema: type: string description: Layer value used by this operation. example: layer - name: createdAt required: false in: query schema: description: >- Date filter for ACL createdAt. Supported formats: - single timestamp in epoch ms (e.g. "1596240000000") to match exactly. - range "startEpochMs,endEpochMs" (both in epoch ms). - open-ended ranges: ",endEpochMs" or "startEpochMs," (omit start or end). type: string description: >- Date filter for ACL createdAt. Supported formats: - single timestamp in epoch ms (e.g. "1596240000000") to match exactly. - range "startEpochMs,endEpochMs" (both in epoch ms). - open-ended ranges: ",endEpochMs" or "startEpochMs," (omit start or end). example: created-at - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get certificate ACL grouped. tags: - Passports ACL /v1/supply-chain/certificates/layer-acl/batch/grant: post: description: Enqueues a batch grant-access job for multiple certificates. operationId: LayerAclGetRouteController_grantBatch parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: >- Grant layer ACL access batch body schema. If `canTransfer` is true and `layers` is not provided or empty, both `private` and `transparent` layers will be assigned. If `canTransfer` is true and `layers` is provided, the specified layers will be assigned. If `canTransfer` is false or omitted, only the explicitly provided layers will be used. anyOf: - type: object properties: certificateIds: type: array items: type: string entity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id expiresAt: anyOf: - type: 'null' - type: number layers: type: array items: anyOf: - const: private type: string - const: transparent type: string canTransfer: type: boolean required: - certificateIds - entity - layers - type: object properties: certificateIds: type: array items: type: string entity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id expiresAt: anyOf: - type: 'null' - type: number canTransfer: type: boolean layers: type: array items: anyOf: - const: private type: string - const: transparent type: string required: - certificateIds - entity - canTransfer example: certificateIds: - certificate-ids entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f expiresAt: 0 layers: - private canTransfer: true description: Request payload for Grant certificate ACL in batch. responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: jobId: type: string queue: description: Queue owning this job ID. type: string required: - jobId required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: jobId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Grant certificate ACL in batch. tags: - Passports ACL /v1/supply-chain/certificates/layer-acl/batch/revoke: post: description: Revokes access permissions for multiple layer ACL records. operationId: LayerAclGetRouteController_revokeBatch parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: items: type: array items: type: object properties: certificateId: type: string id: type: string required: - certificateId - id required: - items example: items: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: Request payload for Revoke certificate ACL in batch. responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: jobId: type: string queue: description: Queue owning this job ID. type: string required: - jobId required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: jobId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Revoke certificate ACL in batch. tags: - Passports ACL /v1/supply-chain/certificates/batch/lookup: post: description: >- Authenticated, read-only collection lookup; no certificate data is modified. Matches one exact, case-sensitive metadata key against any exact candidate value using OR semantics. The key and value must occur on the same metadata entry, and that entry must be visible to the caller. metadataKeys controls only the returned metadata projection; the filter key is returned only when explicitly requested. Status defaults to draft, ready, and published. Results are ordered by updatedAt descending and id ascending. Pagination defaults to page 1 with size 10. Use page/size or offset/limit parameters, but never mix the two styles. operationId: batchLookupCertificatesByMetadata parameters: - name: page required: false in: query schema: minimum: 1 default: 1 description: >- One-based page number. Selects page/size pagination; size defaults to 10. Do not use offset or limit. type: integer description: >- One-based page number. Selects page/size pagination; size defaults to 10. Do not use offset or limit. example: 1 - name: size required: false in: query schema: minimum: 1 maximum: 1000 default: 10 description: >- Page size. Selects page/size pagination; page defaults to 1. Do not use offset or limit. type: integer description: >- Page size. Selects page/size pagination; page defaults to 1. Do not use offset or limit. example: 10 - name: offset required: false in: query schema: minimum: 0 description: >- Zero-based result offset. Selects offset/limit pagination; limit defaults to 10. Do not use page or size. type: integer description: >- Zero-based result offset. Selects offset/limit pagination; limit defaults to 10. Do not use page or size. example: 0 - name: limit required: false in: query schema: minimum: 0 maximum: 1000 description: >- Maximum results. Selects offset/limit pagination; offset defaults to 0. Do not use page or size. type: integer description: >- Maximum results. Selects offset/limit pagination; offset defaults to 0. Do not use page or size. example: 0 requestBody: required: true description: >- Exact metadata filter, requested response metadata keys, and optional certificate statuses. Arrays must contain unique entries. content: application/json: schema: additionalProperties: false description: >- Read-only batch certificate lookup by exact metadata key and candidate values. Standard request normalization converts numeric metadata string fields to strings, wraps scalar array values, and ignores undocumented properties. example: metadata: key: identifiersAndProductData.identifier.batterySerialNumber values: - SN-10001 - SN-10002 metadataKeys: - identifiersAndProductData.identifier.batterySerialNumber status: - published type: object properties: metadata: additionalProperties: false type: object properties: key: minLength: 1 maxLength: 10000 description: Exact, case-sensitive metadata key. example: identifiersAndProductData.identifier.batterySerialNumber type: string values: minItems: 1 maxItems: 500 uniqueItems: true description: >- Candidate values matched with OR semantics against the same metadata entry as key. type: array items: minLength: 0 maxLength: 100000 description: >- Exact, case-sensitive metadata value. Empty strings are valid because metadata values may be empty. example: SN-10001 type: string required: - key - values metadataKeys: minItems: 1 maxItems: 10 uniqueItems: true description: >- Metadata keys to include in each result. These keys do not add filters. example: - identifiersAndProductData.identifier.batterySerialNumber type: array items: minLength: 1 maxLength: 10000 description: Exact, case-sensitive metadata key. example: identifiersAndProductData.identifier.batterySerialNumber type: string status: minItems: 1 maxItems: 4 uniqueItems: true example: - published default: - draft - ready - published description: >- Certificate statuses to include. Omit to include draft, ready, and published certificates. type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string required: - metadata - metadataKeys examples: serialNumbers: summary: Look up published certificates by serial number description: >- Matches either battery serial number and returns only the battery serial number metadata when visible. value: metadata: key: identifiersAndProductData.identifier.batterySerialNumber values: - SN-10001 - SN-10002 metadataKeys: - identifiersAndProductData.identifier.batterySerialNumber status: - published defaultStatuses: summary: Use the default statuses description: >- Omitting status includes draft, ready, and published certificates. value: metadata: key: integration.externalId values: - EXT-100 - EXT-101 metadataKeys: - integration.externalId responses: '200': description: >- Accessible matches in the standard response envelope. total is calculated after access, status, and visible metadata filtering but before pagination. content: application/json: schema: additionalProperties: false description: >- Standard Minespider response envelope. total is calculated before pagination. example: _meta: success: true statusCode: 200 total: 2 messages: [] content: - id: a65dedf0-9f2a-4a54-93ce-1f36120f9123 type: product-passport status: published createdAt: 1785584800000 updatedAt: 1787223600000 publishedAt: 1787223600000 metadata: - key: >- identifiersAndProductData.identifier.batterySerialNumber value: SN-10001 type: object properties: _meta: additionalProperties: false type: object properties: success: example: true const: true type: boolean statusCode: example: 200 const: 200 type: integer total: minimum: 0 example: 2 type: integer required: - success - statusCode - total messages: description: Response messages; empty on success. example: [] type: array items: type: string content: description: >- Matching certificates after access filtering and pagination. type: array items: additionalProperties: false type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID. ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID. type: description: >- Certificate type. The lookup is not restricted to any specific certificate type. example: product-passport anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string status: description: Current certificate lifecycle status. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string createdAt: description: Creation timestamp in epoch milliseconds. example: 1785584800000 type: integer updatedAt: description: >- Last update timestamp in epoch milliseconds, or null when never updated. example: 1787223600000 anyOf: - type: 'null' - type: integer publishedAt: description: >- Publication timestamp in epoch milliseconds, or null when unpublished. example: 1787223600000 anyOf: - type: 'null' - type: integer metadata: description: >- Only requested metadata entries visible to the caller. The array may be empty. type: array items: additionalProperties: false type: object properties: key: description: Requested metadata key visible to the caller. example: >- identifiersAndProductData.identifier.batterySerialNumber type: string value: description: Exact stored value for the metadata key. example: SN-10001 type: string required: - key - value required: - id - ownerEntityId - type - status - createdAt - updatedAt - publishedAt - metadata required: - _meta - messages - content example: _meta: success: true statusCode: 200 total: 2 messages: [] content: - id: a65dedf0-9f2a-4a54-93ce-1f36120f9123 type: product-passport status: published createdAt: 1785584800000 updatedAt: 1787223600000 publishedAt: 1787223600000 metadata: - key: >- identifiersAndProductData.identifier.batterySerialNumber value: SN-10001 '400': description: >- The JSON body is malformed or not an object, a pagination value is invalid, or page/size parameters are mixed with offset/limit parameters. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework validation errors. example: 0 anyOf: - type: string - type: integer required: - success - statusCode - errorCode messages: description: Human-readable error details. example: - >- Expected array length to be greater or equal to 1 at metadata/values type: array items: type: string content: description: Error responses do not contain result content. type: 'null' required: - _meta - messages - content example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - Either offset/limit or page/size pair must be provided content: null '401': description: Authentication is missing or invalid. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework validation errors. example: 0 anyOf: - type: string - type: integer required: - success - statusCode - errorCode messages: description: Human-readable error details. example: - >- Expected array length to be greater or equal to 1 at metadata/values type: array items: type: string content: description: Error responses do not contain result content. type: 'null' required: - _meta - messages - content example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '422': description: >- A required body field, type, enum value, string length, array bound, or array uniqueness constraint is invalid. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework validation errors. example: 0 anyOf: - type: string - type: integer required: - success - statusCode - errorCode messages: description: Human-readable error details. example: - >- Expected array length to be greater or equal to 1 at metadata/values type: array items: type: string content: description: Error responses do not contain result content. type: 'null' required: - _meta - messages - content example: _meta: success: false statusCode: 422 errorCode: 0 messages: - >- Expected array length to be greater or equal to 1 at metadata/values content: null security: - bearer: [] - cookie: [] summary: Look up certificates by metadata values in batch. tags: - Product Passports /v1/supply-chain/certificates/batch/publish: post: description: Enqueues a batch publish job for multiple certificates. operationId: CertificateController_publishBatch parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: certificates: type: array items: type: string required: - certificates example: certificates: - certificates description: Request payload for Publish certificates in batch. responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: jobId: type: string queue: description: Queue owning this job ID. type: string required: - jobId required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: jobId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Publish certificates in batch. tags: - Product Passports /v1/supply-chain/certificates/batch/delete: post: description: Enqueues a batch delete job for multiple certificates. operationId: CertificateController_deleteBatch parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: certificates: type: array items: type: string required: - certificates example: certificates: - certificates description: Request payload for Delete certificates in batch. responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: jobId: type: string queue: description: Queue owning this job ID. type: string required: - jobId required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: jobId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete certificates in batch. tags: - Product Passports /v1/supply-chain/certificates/batch/deprecate: post: description: Enqueues a batch deprecate job for multiple certificates. operationId: CertificateController_deprecateBatch parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: certificates: type: array items: type: string required: - certificates example: certificates: - certificates description: Request payload for Deprecate certificates in batch. responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: jobId: type: string queue: description: Queue owning this job ID. type: string required: - jobId required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: jobId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Deprecate certificates in batch. tags: - Product Passports /v1/supply-chain/certificates/batch/duplicate: post: description: Enqueues a batch duplicate job for multiple certificates. operationId: CertificateController_duplicateBatch parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: certificates: type: array items: type: string required: - certificates example: certificates: - certificates description: Request payload for Duplicate certificates in batch. responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: jobId: type: string queue: description: Queue owning this job ID. type: string required: - jobId required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: jobId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Duplicate certificates in batch. tags: - Product Passports /v1/supply-chain/certificates/batch/patch: post: description: Creates an async batch patch job for multiple certificates. operationId: CertificateController_createBatchPatchJob parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false description: >- Certificate patch operations processed asynchronously in the supplied order. example: items: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f patch: metadata: add: - key: battery.serialNumber value: SN-10001 visibilityLayer: public type: object properties: items: minItems: 1 type: array items: additionalProperties: false type: object properties: certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID patch: additionalProperties: false description: >- Operations to apply to a certificate. At least one top-level operation must be provided. example: metadata: add: - key: battery.serialNumber value: SN-10001 visibilityLayer: public type: object properties: expiresAt: anyOf: - type: number - type: 'null' recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id metadata: minProperties: 1 type: object properties: add: type: array items: description: Create metadata body schema type: object properties: key: minLength: 1 maxLength: 10000 type: string value: minLength: 0 maxLength: 100000 type: string description: >- Metadata value. Scalar Battery Passport URI document fields accept an HTTP(S) URL or a private upload ID from POST /storage/file. Upload IDs are persisted and returned as passport-scoped download URLs. type: description: Metadata type example: string type: string format: description: Metadata format example: string type: string order: description: Defines the sorting order example: -1 type: number visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string required: - key - value - visibilityLayer update: type: array items: type: object allOf: - type: object properties: id: description: >- Persisted metadata UUID or synthetic overlay metadata id anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID - description: Synthetic metadata overlay id pattern: ^(dynamic|computed):[^:]+:.+$ minLength: 1 type: string required: - id - minProperties: 1 description: Update metadata body schema type: object properties: key: minLength: 1 maxLength: 10000 description: Metadata key example: Metadata type: string value: minLength: 0 maxLength: 100000 description: >- Metadata value. Scalar Battery Passport URI document fields accept an HTTP(S) URL or a private upload ID from POST /storage/file. Upload IDs are persisted and returned as passport-scoped download URLs. example: Some metadata type: string order: description: Defines the sorting order example: -1 type: number type: description: Metadata type example: string type: string format: description: Metadata format example: string type: string visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string remove: type: array items: description: >- Persisted metadata UUID or synthetic overlay metadata id anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID - description: Synthetic metadata overlay id pattern: ^(dynamic|computed):[^:]+:.+$ minLength: 1 type: string materials: minProperties: 1 type: object properties: add: type: array items: description: Create certificate material body schema type: object properties: amount: anyOf: - minimum: -9007199254740991 maximum: 9007199254740991 default: 1 type: number - type: 'null' amountType: anyOf: - default: unit description: >- The unit of measurement for the amount. Also accepts 'un' as an alias for 'unit'. type: string - type: 'null' material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - type: 'null' required: - material update: type: array items: type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID required: - id - minProperties: 1 description: Patch certificate material body schema type: object properties: amount: minimum: -9007199254740991 maximum: 9007199254740991 type: number amountType: description: >- The unit of measurement for the amount. Also accepts 'un' as an alias for 'unit'. type: string material: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - type: 'null' originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - type: 'null' remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID attachments: minProperties: 1 type: object properties: add: type: array items: description: Update attachment body schema type: object properties: title: description: Attachment title example: >- Battery passport regulations in EU countries type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string filename: description: User defined attachment filename example: Regulation document type: string path: pattern: ^0x[a-fA-F0-9]{40}$ description: Path to S3 bucket existent file example: >- 0xd33ac1c50a096ab687816185b7122e80eb76345a type: string required: - title - visibilityLayer - filename update: type: array items: type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID required: - id - description: Update attachment body schema type: object properties: title: description: Attachment title example: >- Battery passport regulations in EU countries type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string filename: description: User defined attachment filename example: Regulation document type: string remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID labels: minProperties: 1 type: object properties: add: type: array items: minProperties: 1 description: Create certificate label body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label/tag UUID name: minLength: 1 description: Name of the label example: Label type: string remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID tags: minProperties: 1 type: object properties: add: type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label/tag UUID name: minLength: 1 description: Name of the label example: Label type: string remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID links: minProperties: 1 type: object properties: add: type: array items: description: Create certificate link body schema type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Target certificate UUID visibilityLayer: description: >- Visibility layer can be private only for entity certificate. Other possible values: public, transparent. anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId - visibilityLayer update: type: array items: type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID required: - id - description: Update certificate link body schema type: object properties: visibilityLayer: description: >- Visibility layer can be private only for entity certificate. Other possible values: public, transparent. anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - visibilityLayer remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID required: - certificateId - patch required: - items example: items: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f patch: metadata: add: - key: battery.serialNumber value: SN-10001 visibilityLayer: public description: Request payload for Patch certificates in batch. responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: jobId: type: string queue: type: string total: type: number required: - jobId - total required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: jobId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f total: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Patch certificates in batch. tags: - Product Passports /v1/supply-chain/certificates/batch/patch/{jobId}/status: get: description: Gets the status of an async certificate batch patch job. operationId: CertificateController_batchPatchJobStatus parameters: - name: jobId required: true in: path schema: type: string description: Job identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: type: string queue: type: string state: anyOf: - const: active type: string - const: completed type: string - const: delayed type: string - const: failed type: string - const: paused type: string - const: prioritized type: string - const: waiting type: string - const: waiting-children type: string - const: unknown type: string progress: type: number attemptsMade: type: number timestamp: type: number processedOn: anyOf: - type: number - type: 'null' finishedOn: anyOf: - type: number - type: 'null' returnValue: anyOf: - type: object properties: total: type: number successCount: type: number failedCount: type: number successList: type: array items: type: object properties: index: type: number certificateId: type: string patchedCertificateId: type: string cloned: type: boolean required: - index - certificateId - patchedCertificateId - cloned errorList: type: array items: type: object properties: index: type: number certificateId: type: string error: type: string publicError: type: object properties: code: type: string message: type: string required: - code - message statusCode: type: number required: - index - certificateId - error required: - total - successCount - failedCount - successList - errorList - type: 'null' failedReason: type: string required: - id - queue - state - progress - attemptsMade - timestamp required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f queue: queue state: active progress: 0 attemptsMade: 0 timestamp: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get certificate batch patch job status. tags: - Product Passports /v1/supply-chain/certificates/download: get: description: >- Exports the certificates data in CSV format for easy access and analysis. operationId: CertificateController_download parameters: - name: order required: false in: query schema: default: '-updatedAt' type: string description: Result ordering expression. example: '-updatedAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: status required: false in: query schema: default: draft,ready,published type: string description: Filter by lifecycle status. example: draft,ready,published - name: parent required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: createdBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Created by value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: relates required: false in: query schema: anyOf: - const: me type: string - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Relates value used by this operation. example: me - name: label required: false in: query schema: description: Comma-separated label UUIDs example: 550e8400-e29b-41d4-a716-446655440000 type: string description: Comma-separated label UUIDs example: 550e8400-e29b-41d4-a716-446655440000 - name: labels.name required: false in: query schema: minLength: 1 maxLength: 10000 description: Exact label name example: Approved type: string description: Exact label name example: Approved - name: type required: false in: query schema: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: blockchainPublicLayerHash required: false in: query schema: type: string description: Blockchain public layer hash value used by this operation. example: blockchain-public-layer-hash - name: blockchainTransactionHash required: false in: query schema: type: string description: Blockchain transaction hash value used by this operation. example: blockchain-transaction-hash - name: owner required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Owner value used by this operation. example: owner - name: recipient required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Recipient value used by this operation. example: recipient - name: amountType required: false in: query schema: type: string description: Amount type value used by this operation. example: product-passport - name: measurementType required: false in: query schema: type: string description: Measurement type value used by this operation. example: product-passport - name: material required: false in: query schema: type: string description: Material value used by this operation. example: material - name: materialType required: false in: query schema: type: string description: Material type value used by this operation. example: product-passport - name: materialAmount required: false in: query schema: type: string description: Material amount value used by this operation. example: material-amount - name: id required: false in: query schema: type: string description: Id value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: metadata required: false in: query schema: description: Comma-separated metadata-entry UUIDs example: 550e8400-e29b-41d4-a716-446655440000 type: string description: Comma-separated metadata-entry UUIDs example: 550e8400-e29b-41d4-a716-446655440000 - name: metadata.key required: false in: query schema: minLength: 1 maxLength: 10000 description: >- Exact metadata key. When metadata.value is supplied, both must match the same metadata entry. example: identifiersAndProductData.identifier.batterySerialNumber type: string description: >- Exact metadata key. When metadata.value is supplied, both must match the same metadata entry. example: identifiersAndProductData.identifier.batterySerialNumber - name: metadata.value required: false in: query schema: minLength: 0 maxLength: 100000 description: >- Exact metadata value. When metadata.key is supplied, both must match the same metadata entry. example: BATTERY-SN-001 type: string description: >- Exact metadata value. When metadata.key is supplied, both must match the same metadata entry. example: BATTERY-SN-001 - name: createdAt required: false in: query schema: description: >- Date filter for creation time. Supported formats: - single timestamp in epoch ms (e.g. "1596240000000") to match exactly. - range "startEpochMs,endEpochMs" (both in epoch ms). - open-ended ranges: ",endEpochMs" or "startEpochMs," (omit start or end). type: string description: >- Date filter for creation time. Supported formats: - single timestamp in epoch ms (e.g. "1596240000000") to match exactly. - range "startEpochMs,endEpochMs" (both in epoch ms). - open-ended ranges: ",endEpochMs" or "startEpochMs," (omit start or end). example: created-at - name: publishedAt required: false in: query schema: type: string description: Published at value used by this operation. example: published-at - name: include required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Related resources to include in the response. example: include - name: code_search required: false in: query schema: type: string description: Code search value used by this operation. example: battery - name: ids required: false in: query schema: type: string description: Identifiers to include in the result. example: ids responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Download certificates as CSV. tags: - Product Passports /v1/supply-chain/certificates/import: post: description: >- Import a CSV or Excel file with the full template schema. File-capable cells accept IDs returned by POST /v1/storage/file (upload privately first) or HTTP(S) document URLs; local paths and embedded files are not supported. Scalar BatteryPass document attributes are persisted as URI strings. Existing file arrays use comma-separated references. Remote downloads require public network addresses, allow at most five redirects and have a 30-second total deadline. The entity file-size limit is enforced during download, including decompressed content. Only exact built-in symbol assets may use the configured internal frontend address. Unavailable or blocked external scalar URLs are retained as links without downloading; oversized files fail size validation. The same rules apply to synchronous and queued imports. operationId: CertificateController_import parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: schema: description: JSON schema string for the certificate import pattern: ^\s*\{.*\}\s*$ type: string type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string required: - schema - type description: Request payload for Import certificates. responses: '201': description: Resource created successfully. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Import certificates. tags: - Product Passports /v1/supply-chain/certificates/{id}: get: description: Fetches the details of a specific certificate based on the provided ID. operationId: CertificateController_findOne parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - description: Product passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Entity certificate allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy recipientEntity: anyOf: - description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy - type: 'null' required: - type - standard - description: Battery passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Simplified PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Batch passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Material passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Tyre passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity required: - _meta - messages - content security: - {} - bearer: [] - cookie: [] summary: Get certificate by ID. tags: - Product Passports delete: description: Deletes a specified certificate from the system. operationId: CertificateController_remove parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '204': description: Certificate deleted successfully. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Remove a certificate. tags: - Product Passports patch: description: >- Patches a certificate with operations on recipient, metadata, materials, attachments, labels, tags, and links. For published certificates, the certificate is cloned to draft and the original is deprecated before patching. operationId: CertificateController_patch parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false description: >- Operations to apply to a certificate. At least one top-level operation must be provided. example: metadata: add: - key: battery.serialNumber value: SN-10001 visibilityLayer: public type: object properties: expiresAt: anyOf: - type: number - type: 'null' recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id metadata: minProperties: 1 type: object properties: add: type: array items: description: Create metadata body schema type: object properties: key: minLength: 1 maxLength: 10000 type: string value: minLength: 0 maxLength: 100000 type: string description: >- Metadata value. Scalar Battery Passport URI document fields accept an HTTP(S) URL or a private upload ID from POST /storage/file. Upload IDs are persisted and returned as passport-scoped download URLs. type: description: Metadata type example: string type: string format: description: Metadata format example: string type: string order: description: Defines the sorting order example: -1 type: number visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string required: - key - value - visibilityLayer update: type: array items: type: object allOf: - type: object properties: id: description: >- Persisted metadata UUID or synthetic overlay metadata id anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID - description: Synthetic metadata overlay id pattern: ^(dynamic|computed):[^:]+:.+$ minLength: 1 type: string required: - id - minProperties: 1 description: Update metadata body schema type: object properties: key: minLength: 1 maxLength: 10000 description: Metadata key example: Metadata type: string value: minLength: 0 maxLength: 100000 description: >- Metadata value. Scalar Battery Passport URI document fields accept an HTTP(S) URL or a private upload ID from POST /storage/file. Upload IDs are persisted and returned as passport-scoped download URLs. example: Some metadata type: string order: description: Defines the sorting order example: -1 type: number type: description: Metadata type example: string type: string format: description: Metadata format example: string type: string visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string remove: type: array items: description: >- Persisted metadata UUID or synthetic overlay metadata id anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID - description: Synthetic metadata overlay id pattern: ^(dynamic|computed):[^:]+:.+$ minLength: 1 type: string materials: minProperties: 1 type: object properties: add: type: array items: description: Create certificate material body schema type: object properties: amount: anyOf: - minimum: -9007199254740991 maximum: 9007199254740991 default: 1 type: number - type: 'null' amountType: anyOf: - default: unit description: >- The unit of measurement for the amount. Also accepts 'un' as an alias for 'unit'. type: string - type: 'null' material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - type: 'null' required: - material update: type: array items: type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID required: - id - minProperties: 1 description: Patch certificate material body schema type: object properties: amount: minimum: -9007199254740991 maximum: 9007199254740991 type: number amountType: description: >- The unit of measurement for the amount. Also accepts 'un' as an alias for 'unit'. type: string material: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - type: 'null' originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - type: 'null' remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID attachments: minProperties: 1 type: object properties: add: type: array items: description: Update attachment body schema type: object properties: title: description: Attachment title example: Battery passport regulations in EU countries type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string filename: description: User defined attachment filename example: Regulation document type: string path: pattern: ^0x[a-fA-F0-9]{40}$ description: Path to S3 bucket existent file example: '0xd33ac1c50a096ab687816185b7122e80eb76345a' type: string required: - title - visibilityLayer - filename update: type: array items: type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID required: - id - description: Update attachment body schema type: object properties: title: description: Attachment title example: Battery passport regulations in EU countries type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string filename: description: User defined attachment filename example: Regulation document type: string remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID labels: minProperties: 1 type: object properties: add: type: array items: minProperties: 1 description: Create certificate label body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label/tag UUID name: minLength: 1 description: Name of the label example: Label type: string remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID tags: minProperties: 1 type: object properties: add: type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label/tag UUID name: minLength: 1 description: Name of the label example: Label type: string remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID links: minProperties: 1 type: object properties: add: type: array items: description: Create certificate link body schema type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Target certificate UUID visibilityLayer: description: >- Visibility layer can be private only for entity certificate. Other possible values: public, transparent. anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId - visibilityLayer update: type: array items: type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID required: - id - description: Update certificate link body schema type: object properties: visibilityLayer: description: >- Visibility layer can be private only for entity certificate. Other possible values: public, transparent. anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - visibilityLayer remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID example: metadata: add: - key: battery.serialNumber value: SN-10001 visibilityLayer: public description: Request payload for Patch a certificate. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificate: anyOf: - description: Product passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Entity certificate allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy recipientEntity: anyOf: - description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy - type: 'null' required: - type - standard - description: Battery passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Simplified PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Batch passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Material passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Tyre passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity results: type: object properties: metadata: type: object properties: created: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy updated: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy removed: type: array items: type: string attachments: type: object properties: created: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy updated: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy removed: type: array items: type: string materials: type: object properties: created: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy certificate: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - certificate - createdAt - createdBy updated: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy certificate: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - certificate - createdAt - createdBy removed: type: array items: type: string labels: type: object properties: added: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy removed: type: array items: type: string tags: type: object properties: added: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy removed: type: array items: type: string links: type: object properties: created: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy updated: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy removed: type: array items: type: string required: - certificate - results required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Patch a certificate. tags: - Product Passports /v1/supply-chain/certificates/{id}/latest: get: description: >- Fetches the details of a latest certificate version based on the provided ID. operationId: CertificateController_findLatest parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - description: Product passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Entity certificate allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy recipientEntity: anyOf: - description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy - type: 'null' required: - type - standard - description: Battery passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Simplified PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Batch passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Material passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Tyre passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity required: - _meta - messages - content security: - {} - bearer: [] - cookie: [] summary: Get newest certificate by ID. tags: - Product Passports /v1/supply-chain/certificates: get: description: >- Fetches a collection of certificates based on the provided criteria or filters. operationId: CertificateController_find parameters: - name: order required: false in: query schema: default: '-updatedAt' type: string description: Result ordering expression. example: '-updatedAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: status required: false in: query schema: default: draft,ready,published type: string description: Filter by lifecycle status. example: draft,ready,published - name: parent required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: createdBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Created by value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: relates required: false in: query schema: anyOf: - const: me type: string - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Relates value used by this operation. example: me - name: label required: false in: query schema: description: Comma-separated label UUIDs example: 550e8400-e29b-41d4-a716-446655440000 type: string description: Comma-separated label UUIDs example: 550e8400-e29b-41d4-a716-446655440000 - name: labels.name required: false in: query schema: minLength: 1 maxLength: 10000 description: Exact label name example: Approved type: string description: Exact label name example: Approved - name: type required: false in: query schema: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: blockchainPublicLayerHash required: false in: query schema: type: string description: Blockchain public layer hash value used by this operation. example: blockchain-public-layer-hash - name: blockchainTransactionHash required: false in: query schema: type: string description: Blockchain transaction hash value used by this operation. example: blockchain-transaction-hash - name: owner required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Owner value used by this operation. example: owner - name: recipient required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Recipient value used by this operation. example: recipient - name: amountType required: false in: query schema: type: string description: Amount type value used by this operation. example: product-passport - name: measurementType required: false in: query schema: type: string description: Measurement type value used by this operation. example: product-passport - name: material required: false in: query schema: type: string description: Material value used by this operation. example: material - name: materialType required: false in: query schema: type: string description: Material type value used by this operation. example: product-passport - name: materialAmount required: false in: query schema: type: string description: Material amount value used by this operation. example: material-amount - name: id required: false in: query schema: type: string description: Id value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: metadata required: false in: query schema: description: Comma-separated metadata-entry UUIDs example: 550e8400-e29b-41d4-a716-446655440000 type: string description: Comma-separated metadata-entry UUIDs example: 550e8400-e29b-41d4-a716-446655440000 - name: metadata.key required: false in: query schema: minLength: 1 maxLength: 10000 description: >- Exact metadata key. When metadata.value is supplied, both must match the same metadata entry. example: identifiersAndProductData.identifier.batterySerialNumber type: string description: >- Exact metadata key. When metadata.value is supplied, both must match the same metadata entry. example: identifiersAndProductData.identifier.batterySerialNumber - name: metadata.value required: false in: query schema: minLength: 0 maxLength: 100000 description: >- Exact metadata value. When metadata.key is supplied, both must match the same metadata entry. example: BATTERY-SN-001 type: string description: >- Exact metadata value. When metadata.key is supplied, both must match the same metadata entry. example: BATTERY-SN-001 - name: createdAt required: false in: query schema: description: >- Date filter for creation time. Supported formats: - single timestamp in epoch ms (e.g. "1596240000000") to match exactly. - range "startEpochMs,endEpochMs" (both in epoch ms). - open-ended ranges: ",endEpochMs" or "startEpochMs," (omit start or end). type: string description: >- Date filter for creation time. Supported formats: - single timestamp in epoch ms (e.g. "1596240000000") to match exactly. - range "startEpochMs,endEpochMs" (both in epoch ms). - open-ended ranges: ",endEpochMs" or "startEpochMs," (omit start or end). example: created-at - name: publishedAt required: false in: query schema: type: string description: Published at value used by this operation. example: published-at - name: include required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Related resources to include in the response. example: include - name: code_search required: false in: query schema: type: string description: Code search value used by this operation. example: battery responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: anyOf: - description: Product passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Entity certificate allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy recipientEntity: anyOf: - description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy - type: 'null' required: - type - standard - description: Battery passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Simplified PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Batch passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Material passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Tyre passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get certificates. tags: - Product Passports post: description: >- Generates a new certificate and adds it to the system with the specified details. operationId: CertificateController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: anyOf: - title: Product Passport type: object properties: expiresAt: anyOf: - type: number - type: 'null' links: type: array items: type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId metadata: type: array items: type: object properties: key: type: string value: type: string order: default: -1 type: number type: default: string type: string format: type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - key - value materials: type: array items: type: object properties: amount: default: 1 type: number amountType: default: unit type: string originCertificate: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - material attachments: type: array items: type: object properties: title: minLength: 1 maxLength: 255 type: string filename: minLength: 1 maxLength: 255 type: string originalFilename: minLength: 1 maxLength: 255 type: string visibilityLayer: anyOf: - const: transparent type: string - const: private type: string - const: public type: string file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string required: - title - filename - originalFilename - visibilityLayer type: const: product-passport type: string recipientEntity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - type - title: Battery Passport type: object properties: expiresAt: anyOf: - type: number - type: 'null' links: type: array items: type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId metadata: type: array items: type: object properties: key: type: string value: type: string order: default: -1 type: number type: default: string type: string format: type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - key - value materials: type: array items: type: object properties: amount: default: 1 type: number amountType: default: unit type: string originCertificate: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - material attachments: type: array items: type: object properties: title: minLength: 1 maxLength: 255 type: string filename: minLength: 1 maxLength: 255 type: string originalFilename: minLength: 1 maxLength: 255 type: string visibilityLayer: anyOf: - const: transparent type: string - const: private type: string - const: public type: string file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string required: - title - filename - originalFilename - visibilityLayer type: const: battery-passport type: string recipientEntity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - type - title: PV Passport type: object properties: expiresAt: anyOf: - type: number - type: 'null' links: type: array items: type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId metadata: type: array items: type: object properties: key: type: string value: type: string order: default: -1 type: number type: default: string type: string format: type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - key - value materials: type: array items: type: object properties: amount: default: 1 type: number amountType: default: unit type: string originCertificate: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - material attachments: type: array items: type: object properties: title: minLength: 1 maxLength: 255 type: string filename: minLength: 1 maxLength: 255 type: string originalFilename: minLength: 1 maxLength: 255 type: string visibilityLayer: anyOf: - const: transparent type: string - const: private type: string - const: public type: string file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string required: - title - filename - originalFilename - visibilityLayer type: const: pv-passport type: string recipientEntity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - type - title: Simplified PV Passport type: object properties: expiresAt: anyOf: - type: number - type: 'null' links: type: array items: type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId metadata: type: array items: type: object properties: key: type: string value: type: string order: default: -1 type: number type: default: string type: string format: type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - key - value materials: type: array items: type: object properties: amount: default: 1 type: number amountType: default: unit type: string originCertificate: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - material attachments: type: array items: type: object properties: title: minLength: 1 maxLength: 255 type: string filename: minLength: 1 maxLength: 255 type: string originalFilename: minLength: 1 maxLength: 255 type: string visibilityLayer: anyOf: - const: transparent type: string - const: private type: string - const: public type: string file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string required: - title - filename - originalFilename - visibilityLayer type: const: simplified-pv-passport type: string recipientEntity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - type - title: Batch Passport type: object properties: expiresAt: anyOf: - type: number - type: 'null' links: type: array items: type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId metadata: type: array items: type: object properties: key: type: string value: type: string order: default: -1 type: number type: default: string type: string format: type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - key - value materials: type: array items: type: object properties: amount: default: 1 type: number amountType: default: unit type: string originCertificate: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - material attachments: type: array items: type: object properties: title: minLength: 1 maxLength: 255 type: string filename: minLength: 1 maxLength: 255 type: string originalFilename: minLength: 1 maxLength: 255 type: string visibilityLayer: anyOf: - const: transparent type: string - const: private type: string - const: public type: string file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string required: - title - filename - originalFilename - visibilityLayer type: const: batch-passport type: string recipientEntity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - type - title: Material Passport type: object properties: expiresAt: anyOf: - type: number - type: 'null' links: type: array items: type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId metadata: type: array items: type: object properties: key: type: string value: type: string order: default: -1 type: number type: default: string type: string format: type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - key - value materials: type: array items: type: object properties: amount: default: 1 type: number amountType: default: unit type: string originCertificate: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - material attachments: type: array items: type: object properties: title: minLength: 1 maxLength: 255 type: string filename: minLength: 1 maxLength: 255 type: string originalFilename: minLength: 1 maxLength: 255 type: string visibilityLayer: anyOf: - const: transparent type: string - const: private type: string - const: public type: string file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string required: - title - filename - originalFilename - visibilityLayer type: const: material-passport type: string recipientEntity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - type - title: Tyre Passport type: object properties: expiresAt: anyOf: - type: number - type: 'null' links: type: array items: type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId metadata: type: array items: type: object properties: key: type: string value: type: string order: default: -1 type: number type: default: string type: string format: type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - key - value materials: type: array items: type: object properties: amount: default: 1 type: number amountType: default: unit type: string originCertificate: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - material attachments: type: array items: type: object properties: title: minLength: 1 maxLength: 255 type: string filename: minLength: 1 maxLength: 255 type: string originalFilename: minLength: 1 maxLength: 255 type: string visibilityLayer: anyOf: - const: transparent type: string - const: private type: string - const: public type: string file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string required: - title - filename - originalFilename - visibilityLayer type: const: tyre-passport type: string recipientEntity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - type - title: Entity Certificate type: object properties: expiresAt: anyOf: - type: number - type: 'null' links: type: array items: type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId metadata: type: array items: type: object properties: key: type: string value: type: string order: default: -1 type: number type: default: string type: string format: type: string visibilityLayer: default: private anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - key - value materials: type: array items: type: object properties: amount: default: 1 type: number amountType: default: unit type: string originCertificate: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - material attachments: type: array items: type: object properties: title: minLength: 1 maxLength: 255 type: string filename: minLength: 1 maxLength: 255 type: string originalFilename: minLength: 1 maxLength: 255 type: string visibilityLayer: anyOf: - const: transparent type: string - const: private type: string - const: public type: string file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string required: - title - filename - originalFilename - visibilityLayer type: const: entity type: string recipientEntity: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id standard: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - type - standard example: expiresAt: 0 links: - targetCertId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f visibilityLayer: private metadata: - key: metadata.key value: example-value order: -1 type: string format: format visibilityLayer: private materials: - amount: 1 amountType: unit originCertificate: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f material: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f attachments: - title: title filename: passport.pdf originalFilename: passport.pdf visibilityLayer: transparent file: https://assets.minespider.com/uploads/1234-5678/report.pdf type: product-passport recipientEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: Request payload for Create a certificate. responses: '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - description: Product passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Entity certificate allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy recipientEntity: anyOf: - description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy - type: 'null' required: - type - standard - description: Battery passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Simplified PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Batch passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Material passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Tyre passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a certificate. tags: - Product Passports /v1/supply-chain/certificates/{id}/deprecate: delete: description: >- Marks a certificate as deprecated, indicating that it is no longer valid for use but is retained in the system for reference. operationId: CertificateController_deprecate parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '204': description: Certificate deprecated successfully. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Deprecate a certificate. tags: - Product Passports /v1/supply-chain/certificates/{id}/publish: post: description: >- Makes a certificate publicly available, indicating it is finalized and can be accessed or used. operationId: CertificateController_publish parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - description: Product passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Entity certificate allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy recipientEntity: anyOf: - description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy - type: 'null' required: - type - standard - description: Battery passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Simplified PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Batch passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Material passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Tyre passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity required: - _meta - messages - content '400': description: >- Battery passports must satisfy the DPP header and structure profile. Draft saves and other passport types are unchanged. content: application/json: schema: type: object properties: _meta: type: object properties: errorCode: const: BATTERY_DPP_VALIDATION_FAILED type: string statusCode: const: 400 type: number success: const: false type: boolean validationIssues: type: array items: type: object properties: code: anyOf: - const: DPP_HEADER_REQUIRED type: string - const: DPP_HEADER_TYPE_INVALID type: string - const: DPP_GRANULARITY_INVALID type: string - const: DPP_TIMESTAMP_INVALID type: string - const: DPP_RESERVED_NAME_CONFLICT type: string - const: DPP_ELEMENT_PATH_COLLISION type: string - const: DPP_COLLECTION_EMPTY type: string - const: DPP_ARRAY_TYPES_MIXED type: string path: type: array items: type: string fieldKeys: type: array items: type: string sectionKey: type: string fieldLabels: type: array items: type: object properties: key: type: string i18nId: type: string fallback: type: string required: - key required: - code - path - fieldKeys required: - errorCode - statusCode - success content: type: 'null' messages: type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: BATTERY_DPP_VALIDATION_FAILED statusCode: 400 success: false content: null messages: - messages '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Publish a certificate. tags: - Product Passports /v1/supply-chain/certificates/{id}/clone: post: description: >- Creates a copy of an existing certificate, including all relevant data, to allow for further modifications or use. operationId: CertificateController_clone parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - description: Product passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Entity certificate allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy recipientEntity: anyOf: - description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy - type: 'null' required: - type - standard - description: Battery passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Simplified PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Batch passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Material passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Tyre passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Clone a certificate. tags: - Product Passports /v1/supply-chain/certificates/{id}/tree: get: description: >- Retrieves the hierarchical structure of certificates, displaying their relationships and dependencies. operationId: CertificateController_tree parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: direction required: false in: query schema: default: upstream description: Direction of certificate links to fetch anyOf: - const: upstream type: string - const: downstream type: string description: Direction of certificate links to fetch example: upstream - name: depth required: false in: query schema: minimum: 1 maximum: 100 description: Maximum depth of tree traversal (number of levels) type: number description: Maximum depth of tree traversal (number of levels) example: 1 responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificate: anyOf: - type: object properties: undisclosed: description: Whether certificate undisclosed or not example: false type: boolean version: description: Certificate version example: 0 type: number status: description: Certificate status example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string type: description: Certificate type example: product-passport anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string parentId: type: string ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: >- Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: >- Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy certificate: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - certificate - createdAt - createdBy required: - undisclosed - version - status - type - createdAt - id - code - ownerEntity - createdBy - materials - type: object properties: undisclosed: description: Whether certificate undisclosed or not example: false type: boolean version: description: Certificate version example: 0 type: number status: description: Certificate status example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string type: description: Certificate type example: product-passport anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string parentId: type: string ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: >- Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy required: - undisclosed - version - status - type - createdAt - id - code - ownerEntity - createdBy - standard upstream: description: Upstream type: array items: $ref: >- #/paths/~1v1~1supply-chain~1certificates~1{id}~1tree/get/responses/200/content/application~1json/schema/properties/content flows: description: Material flows between certificates in the tree type: array items: type: object properties: fromCertId: description: Source certificate id type: string toCertId: description: Destination certificate id type: string materialId: description: Material id type: string value: description: Flow value type: number exceeded: description: Whether the flow exceeded available amount type: boolean exceededAmount: description: >- Amount by which the flow exceeded the available amount type: number originProducedAmount: description: Produced amount in origin type: number originUsedAmount: description: Used amount in origin type: number required: - fromCertId - toCertId - materialId - value - exceeded - exceededAmount - originProducedAmount - originUsedAmount required: - certificate - upstream - flows required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get certificate tree. tags: - Product Passports /v1/supply-chain/certificates/{id}/history: get: description: >- Fetches the historical records and changes made to a specific certificate over time. operationId: CertificateController_history parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: sort required: false in: query schema: default: version type: string description: Field used to sort results. example: version - name: include required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Related resources to include in the response. example: include responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: anyOf: - description: Product passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Entity certificate allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy recipientEntity: anyOf: - description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy - type: 'null' required: - type - standard - description: Battery passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Simplified PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Batch passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Material passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Tyre passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity required: - _meta - messages - content security: - {} - bearer: [] - cookie: [] summary: Get certificate history. tags: - Product Passports /v1/supply-chain/certificates/{id}/receipt: delete: description: >- This operation can only be performed by the recipient of the certificate. operationId: CertificateController_removeReceipt parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '204': description: Certificate receipt removed successfully. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Set the receipt flag of the certificate to false. tags: - Product Passports post: description: >- This operation can only be performed by the recipient of the certificate. operationId: CertificateController_createReceipt parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '204': description: Certificate receipt recorded successfully. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Set the receipt flag of the certificate to true. tags: - Product Passports /v1/supply-chain/certificates/batch: post: description: >- Allows the bulk creation of multiple certificates at once, adding them to the system with the specified details. operationId: CertificateController_createMany parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Batch create certificates body schema type: array items: anyOf: - title: Product Passport description: Batch create product passport body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID links: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy tags: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy attachments: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string metadata: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string materials: type: array items: type: object properties: amount: description: Material amount value example: 3 type: number amountType: description: Material type name example: Liquids/Gases type: string originCertificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID required: - id required: - amount - amountType - material required: - type - materials - title: Battery Passport description: Batch create battery passport body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID links: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy tags: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy attachments: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string metadata: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string materials: type: array items: type: object properties: amount: description: Material amount value example: 3 type: number amountType: description: Material type name example: Products type: string originCertificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID required: - id required: - amount - amountType - material required: - type - materials - title: PV Passport description: Batch create pv passport body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID links: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy tags: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy attachments: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string metadata: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string materials: type: array items: type: object properties: amount: description: Material amount value example: 3 type: number amountType: description: Material type name example: Products type: string originCertificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID required: - id required: - amount - amountType - material required: - type - materials - title: Simplified PV Passport description: Batch create simplified pv passport body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID links: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy tags: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy attachments: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string metadata: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string materials: type: array items: type: object properties: amount: description: Material amount value example: 3 type: number amountType: description: Material type name example: Products type: string originCertificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID required: - id required: - amount - amountType - material required: - type - materials - title: Batch Passport description: Batch create batch passport body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID links: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy tags: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy attachments: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string metadata: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string materials: type: array items: type: object properties: amount: description: Material amount value example: 3 type: number amountType: description: Material type name example: Products type: string originCertificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID required: - id required: - amount - amountType - material required: - type - materials - title: Material Passport description: Batch create material passport body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID links: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy tags: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy attachments: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string metadata: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string materials: type: array items: type: object properties: amount: description: Material amount value example: 3 type: number amountType: description: Material type name example: Products type: string originCertificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID required: - id required: - amount - amountType - material required: - type - materials - title: Tyre Passport description: Batch create tyre passport body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID links: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy tags: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy attachments: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string metadata: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string materials: type: array items: type: object properties: amount: description: Material amount value example: 3 type: number amountType: description: Material type name example: Products type: string originCertificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID required: - id required: - amount - amountType - material required: - type - materials - title: Entity Certificate description: Batch create entity certificate body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID links: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy tags: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy attachments: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string metadata: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string standard: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id required: - type - standard example: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f links: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f targetCertId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f undisclosedCertId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f undisclosed: true visibilityLayer: transparent createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f updatedAt: null updatedBy: null deletedAt: null deletedBy: null labels: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f updatedAt: null updatedBy: null deletedAt: null deletedBy: null tags: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f updatedAt: null updatedBy: null deletedAt: null deletedBy: null attachments: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f filename: Regulation document path: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca title: Battery passport regulations in EU countries checksum: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 visibilityLayer: public certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f mimeType: application/pdf originalFilename: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf encoding: 7bit size: 160459 file: https://assets.minespider.com/uploads/1234-5678/report.pdf createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f updatedAt: null updatedBy: null deletedAt: null deletedBy: null metadata: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key value: example-value order: -1 type: product-passport format: format certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f visibilityLayer: transparent description: description createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f updatedAt: null updatedBy: null deletedAt: null deletedBy: null type: product-passport recipientEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Minespider Germany GmbH materials: - amount: 3 amountType: Liquids/Gases originCertificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f material: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: Request payload for Create many certificates. responses: '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: success: type: array items: anyOf: - description: Product passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Entity certificate allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy recipientEntity: anyOf: - description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy - type: 'null' required: - type - standard - description: Battery passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Simplified PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Batch passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Material passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Tyre passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity errors: type: array items: example: >- Error occurred while creating certificate from CSV. Failed: 1 certificate type: string required: - success - errors required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create many certificates. tags: - Product Passports /v1/supply-chain/certificates/csv: post: description: >- Uploads a CSV file containing multiple certificates to be processed and added to the system. operationId: CertificateController_createManyCsv parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Upload file body type: object properties: file: format: binary description: The file to upload as form-data type: string required: - file description: Request payload for Upload certificates CSV file. responses: '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: success: description: Number of successfully created certificates example: 5 type: number certificateIds: type: array items: description: IDs of all successfully created certificates example: 123e4567-e89b-12d3-a456-426614174000 type: string errors: type: array items: example: >- Error occurred while creating certificate from CSV. Failed: 1 certificate type: string required: - success - certificateIds - errors required: - _meta - messages - content example: _meta: success: true statusCode: 201 messages: - Success content: success: 5 certificateIds: - 123e4567-e89b-12d3-a456-426614174000 errors: - >- Error occurred while creating certificate from CSV. Failed: 1 certificate '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Upload certificates CSV file. tags: - Product Passports /v1/supply-chain/certificates/import/{queueName}/{jobId}/status: get: description: Gets the status of the import job. operationId: CertificateController_importStatus parameters: - name: queueName required: true in: path schema: type: string description: Queue name identifier. example: queue-name - name: jobId required: true in: path schema: type: string description: Job identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get import job status. tags: - Product Passports /v1/supply-chain/certificates/{id}/duplicate: post: description: Creates a copy of an existing certificate, including all relevant data. operationId: CertificateController_duplicate parameters: - name: id required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - description: Product passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: product-passport const: product-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Entity certificate allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: entity const: entity type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy recipientEntity: anyOf: - description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy - type: 'null' required: - type - standard - description: Battery passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: battery-passport const: battery-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: pv-passport const: pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Simplified PV passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: simplified-pv-passport const: simplified-pv-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Batch passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: batch-passport const: batch-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Material passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport and material-passport. example: material-passport const: material-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity - description: Tyre passport allOf: - type: object allOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID parent: anyOf: - type: 'null' - type: object allOf: - description: Parent certificate type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID type: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string parent: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent certificate UUID ownerEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID recipientEntity: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Recipient entity UUID standard: anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - root - type - version - code - cid - ownerEntity - status - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy root: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: First version certificate UUID version: minimum: 0 description: Version number of the certificate example: 0 type: number code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string cid: description: >- Certificates identifier from Web3 service. Assigning after certificate get published. example: >- bafybei3ls2h3qwohtaarmxkwdnvjc3xp1b7qjh443bqkcfekeswovttl4g anyOf: - type: 'null' - type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r anyOf: - type: 'null' - type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 anyOf: - type: 'null' - type: string issuerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: >- The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: >- Blockchain address reserved for an entity example: >- 0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy ownerEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Owner entity UUID; preserves the existing ownerEntity representation. status: description: >- A condition of the certificate. Possible values: draft, ready and published. example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string undisclosedId: example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string labels: description: Array of certificate labels type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string label: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - label - createdAt - createdBy tags: description: Array of certificate tags type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID target: description: UUID of a Certificate type: string type: const: Certificate type: string tag: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: >- Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - target - type - tag - createdAt - createdBy links: description: Array of certificate links type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy metadata: description: Array of certificate metadata type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy attachments: description: Array of certificate attachments type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: >- Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy disqualifications: description: Array of certificate disqualifications type: array publishedAt: description: Certificates publishing date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number expiresAt: description: Certificates expiration date timestamp example: 1686042132022 anyOf: - type: 'null' - type: number receivedAt: anyOf: - type: 'null' - description: Timestamp when certificate was received example: 1686042132022 type: number disqualifiedAt: anyOf: - type: 'null' - description: >- Timestamp when certificate was disqualified example: 1686042132022 type: number receivedBy: description: >- UUID of a member who received the certificate example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string linked: description: >- Whether certificate was already linked or not example: true default: false type: boolean required: - id - parent - root - version - code - cid - ownerEntity - status - labels - tags - links - metadata - attachments - publishedAt - linked - type: object properties: createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - createdAt - createdBy - type: object properties: type: description: >- Certificates type. Possible values entity, product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport and tyre-passport. example: tyre-passport const: tyre-passport type: string materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - createdAt - createdBy recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy required: - type - materials - recipientEntity required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Duplicate a certificate. tags: - Product Passports /v1/supply-chain/certificates/public-links/{type}/{entityId}/{identifier}: get: description: >- Resolves a public passport identifier within the specified owner entity and returns the canonical public certificate URL. operationId: CertificatePublicLinkController_resolveIdentifier parameters: - name: type required: true in: path schema: type: string description: Type identifier. example: product-passport - name: entityId required: true in: path schema: type: string description: Entity identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: identifier required: true in: path schema: type: string description: Identifier identifier. example: identifier responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Resolved certificate UUID. strategy: anyOf: - const: gs1 type: string - const: battery-identifier type: string required: - certificateId - strategy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f strategy: gs1 security: [] summary: Resolve a public certificate URL by type, owner entity, and identifier. tags: - Certificate Public Links /v1/supply-chain/certificates/public-links/gs1: get: description: >- Pass path segments as repeated query params in order, for example segments=01&segments={gtin}. operationId: CertificatePublicLinkController_resolveGs1 parameters: - name: segments required: true in: query schema: type: array items: type: string description: Segments value used by this operation. example: - segments responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Resolved certificate UUID. strategy: anyOf: - const: gs1 type: string - const: battery-identifier type: string required: - certificateId - strategy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f strategy: gs1 security: [] summary: Resolve a GS1 Digital Link path to a public certificate. tags: - Certificate Public Links /v1/supply-chain/certificates/{certificateId}/layer-acl: get: description: >- Retrieves the access control list (ACL) related to a specific certificate, showing all relevant permissions. operationId: LayerAclController_findAll parameters: - name: granter required: false in: query schema: type: string description: Granter value used by this operation. example: granter - name: grantee required: false in: query schema: type: string description: Grantee value used by this operation. example: grantee - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get all relevant certificate ACL. tags: - Passports ACL post: description: >- Grants specific access permissions to a certificate for a designated entity or user. operationId: LayerAclController_grant parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: >- Grant layer ACL access body schema. If `canTransfer` is true and `layers` is not provided or empty, both `private` and `transparent` layers will be assigned. If `canTransfer` is true and `layers` is provided, the specified layers will be assigned. If `canTransfer` is false or omitted, only the explicitly provided layers will be used. anyOf: - type: object properties: entity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id expiresAt: anyOf: - type: 'null' - type: number layers: type: array items: anyOf: - const: private type: string - const: transparent type: string canTransfer: type: boolean required: - entity - layers - type: object properties: entity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID required: - id expiresAt: anyOf: - type: 'null' - type: number canTransfer: type: boolean layers: type: array items: anyOf: - const: private type: string - const: transparent type: string required: - entity - canTransfer example: entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f expiresAt: 0 layers: - private canTransfer: true description: Request payload for Grant certificate ACL. responses: '201': description: Resource created successfully. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Grant certificate ACL. tags: - Passports ACL /v1/supply-chain/certificates/{certificateId}/layer-acl/{id}: delete: description: >- Revokes the access permissions previously granted to a certificate for a designated entity or user. operationId: LayerAclController_revoke parameters: - name: id required: true in: path schema: type: string description: Layer acl identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Revoke certificate ACL. tags: - Passports ACL /v1/supply-chain/materials: post: description: >- Adds a new material to the system for use in certificate creation or other processes. operationId: MaterialController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create material body schema type: object properties: name: minLength: 1 maxLength: 255 type: string default: description: >- Whether the material is default or not. Non-default materials are custom materials created by users type: boolean type: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id image: anyOf: - pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 type: string - type: 'null' required: - name - type example: name: name default: true type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f image: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 description: Request payload for Create a material. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Butan alias: butan active: true default: false type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a material. tags: - Materials get: description: Fetches a collection of materials available in the system. operationId: MaterialController_find parameters: - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true - name: createdBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Creators UUID description: Creators UUID example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: accessedBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Accessed by user UUID description: Accessed by user UUID example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: type required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID description: Material type UUID example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Butan alias: butan active: true default: false type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve materials collection. tags: - Materials /v1/supply-chain/materials/{id}: get: description: Retrieves a specific material using its unique identifier. operationId: MaterialController_findOne parameters: - name: id required: true in: path schema: type: string description: Material identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Butan alias: butan active: true default: false type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get a material by id. tags: - Materials delete: description: Removes a material from the system by its unique identifier. operationId: MaterialController_remove parameters: - name: id required: true in: path schema: type: string description: Material identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a material. tags: - Materials patch: description: Updates the details of an existing material in the system. operationId: MaterialController_update parameters: - name: id required: true in: path schema: type: string description: Material identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: minProperties: 1 description: Update material body schema type: object properties: name: minLength: 1 maxLength: 255 type: string default: description: >- Whether the material is default or not. Non-default materials are custom materials created by users type: boolean type: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id image: anyOf: - pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 type: string - type: 'null' example: name: name default: true type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f image: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 description: Request payload for Patch a material. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Butan alias: butan active: true default: false type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Patch a material. tags: - Materials /v1/supply-chain/material-types: post: description: >- Adds a new material type to the system, which can be used to categorize and manage materials. operationId: MaterialTypeController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Create material type body schema type: object properties: name: minLength: 1 maxLength: 255 description: Material type name example: Liquids/Gases type: string measurementType: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID required: - id required: - name - measurementType example: name: Liquids/Gases measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: Request payload for Create a material type. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a material type. tags: - Material Types get: description: Fetches a collection of all material types available in the system. operationId: MaterialTypeController_find parameters: - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: active required: false in: query schema: anyOf: - description: Whether an entity active or not default: true example: true type: boolean - description: This filter also supports "all" value const: all type: string description: Filter by active state. example: true - name: createdBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type creators UUID description: Material type creators UUID example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve material types collection. tags: - Material Types /v1/supply-chain/material-types/{id}: patch: description: Updates the details of an existing material type in the system. operationId: MaterialTypeController_update parameters: - name: id required: true in: path schema: type: string description: Material type identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: minProperties: 1 description: Update material type body schema type: object properties: name: minLength: 1 maxLength: 255 description: Material type name example: Liquids/Gases type: string measurementType: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID required: - id active: description: Whether the material type is active or not example: true type: boolean example: name: Liquids/Gases measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f active: true description: Request payload for Patch a material type. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Patch a material type. tags: - Material Types delete: description: Removes a material type from the system by its unique identifier. operationId: MaterialTypeController_remove parameters: - name: id required: true in: path schema: type: string description: Material type identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a material type. tags: - Material Types get: description: Retrieves a specific material type using its unique identifier. operationId: MaterialTypeController_findOne parameters: - name: id required: true in: path schema: type: string description: Material type identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get a material type by id. tags: - Material Types /v1/supply-chain/certificates/{certificateId}/links: post: description: >- Generates a link that points to a specific certificate for easy sharing or access. operationId: CertificateLinkController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Create certificate link body schema type: object properties: targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Target certificate UUID visibilityLayer: description: >- Visibility layer can be private only for entity certificate. Other possible values: public, transparent. anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - targetCertId - visibilityLayer example: targetCertId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f visibilityLayer: transparent description: Request payload for Create a link to the certificate. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f targetCertId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f undisclosed: true visibilityLayer: transparent createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a link to the certificate. tags: - Passport Links get: description: Fetches all links associated with a specific certificate. operationId: CertificateLinkController_find parameters: - name: targetCertId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Target certificate UUID description: Target certificate UUID example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: visibilityLayer required: false in: query schema: description: >- Visibility layer can not be private. Possible values: public, transparent anyOf: - const: public type: string - const: transparent type: string description: >- Visibility layer can not be private. Possible values: public, transparent example: public - name: order required: false in: query schema: example: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f targetCertId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f undisclosed: true visibilityLayer: transparent createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: - {} - bearer: [] - cookie: [] summary: Retrieve collection of links to the certificate. tags: - Passport Links /v1/supply-chain/certificates/{certificateId}/links/{id}: delete: description: >- Removes a previously created link associated with a specific certificate. operationId: CertificateLinkController_remove parameters: - name: id required: true in: path schema: type: string description: Link identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Remove a link from the certificate. tags: - Passport Links patch: description: Modifies an existing link associated with a specific certificate. operationId: CertificateLinkController_update parameters: - name: id required: true in: path schema: type: string description: Link identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Update certificate link body schema type: object properties: visibilityLayer: description: >- Visibility layer can be private only for entity certificate. Other possible values: public, transparent. anyOf: - const: transparent type: string - const: private type: string - const: public type: string required: - visibilityLayer example: visibilityLayer: transparent description: Request payload for Patch a link to the certificate. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f targetCertId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f undisclosed: true visibilityLayer: transparent createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Patch a link to the certificate. tags: - Passport Links get: description: Retrieves the link associated with a specific certificate. operationId: CertificateLinkController_findOne parameters: - name: id required: true in: path schema: type: string description: Link identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate link type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate link UUID certId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Origin certificate UUID (newer one) targetCertId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Linked certificate UUID (older one) undisclosedCertId: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Undisclosed certificate UUID - type: 'null' - type: string undisclosed: example: true type: boolean visibilityLayer: description: Link visibility layer anyOf: - const: transparent type: string - const: private type: string - const: public type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certId - targetCertId - undisclosed - visibilityLayer - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f targetCertId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f undisclosed: true visibilityLayer: transparent createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: - {} - bearer: [] - cookie: [] summary: Get a link to the certificate. tags: - Passport Links /v1/supply-chain/certificates/{certificateId}/links/tree: get: description: >- Fetches the hierarchical structure of links associated with a specific certificate. operationId: CertificateLinkController_tree parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificate: anyOf: - type: object properties: undisclosed: description: Whether certificate undisclosed or not example: false type: boolean version: description: Certificate version example: 0 type: number status: description: Certificate status example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string type: description: Certificate type example: product-passport anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string parentId: type: string ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: >- Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string recipientEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: >- Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy materials: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: >- Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy certificate: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - certificate - createdAt - createdBy required: - undisclosed - version - status - type - createdAt - id - code - ownerEntity - createdBy - materials - type: object properties: undisclosed: description: Whether certificate undisclosed or not example: false type: boolean version: description: Certificate version example: 0 type: number status: description: Certificate status example: published anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string type: description: Certificate type example: product-passport anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string blockchainPublicLayerHash: description: >- Certificates blockchain public layer hash. Assigning after certificate get published. example: >- 0x89adea5db8f937da67f90b6c7bd642a9c58aa9f27954a6ad19fdb09db76e9d2r type: string blockchainTransactionHash: description: >- Certificates blockchain transaction hash. Assigning after certificate get published. example: >- 0x9a587496d9af43799ce0201b1bod02050er9716d607be2043f2d18329dbaffc2 type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID code: minLength: 4 maxLength: 12 description: >- An alternative code to reference the certificate example: a1b2c3d4 type: string parentId: type: string ownerEntity: description: Entity type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity UUID name: description: Entity name example: Minespider Germany GmbH type: string avatar: description: URL to avatar assigned to an entity example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/7711cbec-1dee-4cce-b92e-eb9b2a2c565d anyOf: - type: string - type: 'null' features: anyOf: - description: Available features for this entity example: '["BATTERY_PASSPORT"]' type: string - type: 'null' alias: description: Unique slug string of an entity name example: minespider-germany-gmbh type: string email: anyOf: - pattern: >- ^[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+(?:.[A-Za-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ minLength: 1 maxLength: 255 description: Email address example: john@mail.com type: string - type: 'null' type: description: Entities' type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Entity type UUID name: description: Entity type name example: Producer type: string alias: description: Unique slug string of the type example: producer type: string active: description: >- Whether the type is active on the platform example: true type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - active - createdAt - createdBy brand: description: Entity brand name example: minespider anyOf: - type: string - type: 'null' about: anyOf: - type: 'null' - description: Entity about information example: >- We enable you to be at the cutting-edge of sustainability. type: string active: description: Whether an entity is active example: true type: boolean approved: description: >- Whether an entity is administratively approved, which means the recorded data was qualified by the Platform example: true type: boolean frozen: description: >- Whether an entity was frozen, which means it has at least one administrator to manage its data. example: true type: boolean cahraArea: description: >- Whether an entity is located in a Conflict-Affected and High-risk Area example: false type: boolean streetAddress: description: >- The street name where an entity is located officially example: Dunckerstrasse 79 anyOf: - type: string - type: 'null' city: description: >- The city's name where an entity is located officially example: Berlin anyOf: - type: string - type: 'null' country: description: >- The country's ISO 3166-1 alpha-2 code where an entity is located officially example: DE anyOf: - type: string - type: 'null' phoneCountryCode: description: >- The international phone code of the country example: '+49' anyOf: - type: string - type: 'null' phoneAreaCode: description: The regional/state/providence phone code example: '30' anyOf: - type: string - type: 'null' phoneNumber: description: The valid phone number of an entity example: '123456' anyOf: - type: string - type: 'null' registrationNumber: description: The valid registration number of an entity example: '123456' anyOf: - type: string - type: 'null' latitude: description: >- Latitude coordinate number where an entity is located example: 52.543304 anyOf: - type: string - type: number - type: 'null' longitude: description: >- Longitude coordinate number where an entity is located example: 13.421241 anyOf: - type: string - type: number - type: 'null' googleMapsLink: description: >- A link to easily locate the company in Google Maps. example: https://goo.gl/maps/7XARjBaCaWoJeqEA6 anyOf: - type: string - type: 'null' entityBlockchainAddress: description: Blockchain address reserved for an entity example: '0xfd5E1aBD0F5B0fa774e1aD076F4a038754A45F86' type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - features - alias - email - type - active - approved - frozen - cahraArea - entityBlockchainAddress - createdAt - createdBy createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string standard: description: Standard type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Standard UUID name: minLength: 1 maxLength: 255 description: Standard name example: Test template type: string active: default: true description: >- Status of activity. False means it's soft deleted. example: true type: boolean alias: minLength: 1 maxLength: 255 description: Unique slug string of a standard example: test-template type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of standard's owner properties: description: The list of standard properties type: array createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - alias - ownedBy - createdAt - createdBy required: - undisclosed - version - status - type - createdAt - id - code - ownerEntity - createdBy - standard upstream: description: Upstream type: array items: $ref: >- #/paths/~1v1~1supply-chain~1certificates~1{certificateId}~1links~1tree/get/responses/200/content/application~1json/schema/properties/content flows: description: Material flows between certificates in the tree type: array items: type: object properties: fromCertId: description: Source certificate id type: string toCertId: description: Destination certificate id type: string materialId: description: Material id type: string value: description: Flow value type: number exceeded: description: Whether the flow exceeded available amount type: boolean exceededAmount: description: >- Amount by which the flow exceeded the available amount type: number originProducedAmount: description: Produced amount in origin type: number originUsedAmount: description: Used amount in origin type: number required: - fromCertId - toCertId - materialId - value - exceeded - exceededAmount - originProducedAmount - originUsedAmount required: - certificate - upstream - flows required: - _meta - messages - content security: - {} - bearer: [] - cookie: [] summary: Retrieve links tree of the certificate. tags: - Passport Links /v1/supply-chain/certificates/{certificateId}/attachments: post: description: >- Uploads and associates a new attachment with a specific certificate in the system. operationId: AttachmentController_upload parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: >- Update attachment body schema. The attachment can be provided either as a new file or as a reference to an existing S3 bucket path. anyOf: - additionalProperties: false type: object properties: title: description: Attachment title example: Battery passport regulations in EU countries type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string filename: description: User defined attachment filename example: Regulation document type: string path: pattern: ^0x[a-fA-F0-9]{40}$ description: Path to S3 bucket existent file example: '0xd33ac1c50a096ab687816185b7122e80eb76345a' type: string required: - title - visibilityLayer - filename - path - additionalProperties: false type: object properties: title: description: Attachment title example: Battery passport regulations in EU countries type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string filename: description: User defined attachment filename example: Regulation document type: string file: format: binary description: The file to upload as form-data type: string required: - title - visibilityLayer - filename - file example: title: Battery passport regulations in EU countries visibilityLayer: public filename: Regulation document path: '0xd33ac1c50a096ab687816185b7122e80eb76345a' description: Request payload for Create an attachment related to a certificate. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f filename: Regulation document path: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca title: Battery passport regulations in EU countries checksum: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 visibilityLayer: public certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f mimeType: application/pdf originalFilename: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf encoding: 7bit size: 160459 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create an attachment related to a certificate. tags: - Passport Attachments get: description: Fetches a collection of files associated with a specific certificate. operationId: AttachmentController_getMany parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: order required: false in: query schema: type: string description: Result ordering expression. example: createdAt:desc - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f filename: Regulation document path: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca title: Battery passport regulations in EU countries checksum: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 visibilityLayer: public certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f mimeType: application/pdf originalFilename: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf encoding: 7bit size: 160459 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: - {} - bearer: [] - cookie: [] summary: Retrieve the collection of files related to a certificate. tags: - Passport Attachments /v1/supply-chain/certificates/{certificateId}/attachments/{attachmentId}/download: get: description: >- Fetches and allows the download of an attachment associated with a specific certificate. operationId: AttachmentController_download parameters: - name: attachmentId required: true in: path schema: type: string description: Attachment identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. security: - {} - bearer: [] - cookie: [] summary: Download an attachment related to a certificate. tags: - Passport Attachments /v1/supply-chain/certificates/{certificateId}/attachments/{id}: get: description: >- Fetches the details of an attachment associated with a specific certificate. operationId: AttachmentController_getOne parameters: - name: id required: true in: path schema: type: string description: Attachment identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f filename: Regulation document path: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca title: Battery passport regulations in EU countries checksum: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 visibilityLayer: public certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f mimeType: application/pdf originalFilename: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf encoding: 7bit size: 160459 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: - {} - bearer: [] - cookie: [] summary: Retrieve an attachment related to a certificate. tags: - Passport Attachments patch: description: Modifies an existing attachment associated with a specific certificate. operationId: AttachmentController_update parameters: - name: id required: true in: path schema: type: string description: Attachment identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Update attachment body schema type: object properties: title: description: Attachment title example: Battery passport regulations in EU countries type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string filename: description: User defined attachment filename example: Regulation document type: string example: title: Battery passport regulations in EU countries visibilityLayer: public filename: Regulation document description: Request payload for Patch an attachment related to a certificate. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f filename: Regulation document path: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca title: Battery passport regulations in EU countries checksum: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 visibilityLayer: public certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f mimeType: application/pdf originalFilename: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf encoding: 7bit size: 160459 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Patch an attachment related to a certificate. tags: - Passport Attachments delete: description: >- Removes an attachment associated with a specific certificate from the system. operationId: AttachmentController_remove parameters: - name: id required: true in: path schema: type: string description: Attachment identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete an attachment related to a certificate. tags: - Passport Attachments /v1/webhooks: post: description: >- WEBHOOKS feature and entity administrator credentials required; tenant impersonation and external tenant principals must use tenant webhook management. Save the signing secret returned by creation; it is not included in list or update responses. See [Webhooks](#tag/Webhooks) for receiver instructions. operationId: EntityWebhookController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false type: object properties: endpointUrl: minLength: 1 maxLength: 2048 type: string description: maxLength: 255 type: string eventTypes: minItems: 1 uniqueItems: true type: array items: anyOf: - const: com.minespider.certificate.import.completed.v1 type: string - const: com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string required: - endpointUrl - eventTypes example: endpointUrl: https://example.com/resource description: description eventTypes: - com.minespider.certificate.import.completed.v1 description: Request payload for Create an entity webhook subscription. responses: '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object allOf: - type: object properties: id: type: string entityOwnerId: anyOf: - type: string - type: 'null' tenantOwnerId: anyOf: - type: string - type: 'null' endpointUrl: type: string description: anyOf: - type: string - type: 'null' active: type: boolean eventTypes: type: array items: anyOf: - const: >- com.minespider.certificate.import.completed.v1 type: string - const: >- com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: >- com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string secretHint: type: string createdBy: description: >- Authenticated member ID for entity subscriptions; authenticated tenant ID for tenant subscriptions. type: string updatedBy: anyOf: - type: string - type: 'null' createdAt: type: number updatedAt: anyOf: - type: number - type: 'null' required: - id - entityOwnerId - tenantOwnerId - endpointUrl - description - active - eventTypes - secretHint - createdBy - updatedBy - createdAt - updatedAt - type: object properties: secret: type: string required: - secret required: - _meta - messages - content '400': description: >- Invalid fields/events or URL: HTTPS with public DNS/IP addresses and no credentials required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- WEBHOOKS feature and entity administrator credentials required; tenant impersonation and external tenant principals must use tenant webhook management. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '422': description: Body does not match the subscription schema. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 422 errorCode: 0 messages: - The request failed validation. content: null '503': description: Webhooks are disabled. security: - bearer: [] - cookie: [] summary: Create an entity webhook subscription. tags: - Webhooks get: operationId: EntityWebhookController_list parameters: - name: page required: false in: query schema: minimum: 1 default: 1 description: One-based page. Use page/size or offset/limit, never both. type: number description: One-based page. Use page/size or offset/limit, never both. example: 1 - name: size required: false in: query schema: exclusiveMinimum: 0 maximum: 1000 default: 10 type: number description: Number of results per page. example: 10 - name: offset required: false in: query schema: minimum: 0 default: 0 description: Zero-based offset; alternative to page/size. type: number description: Zero-based offset; alternative to page/size. example: 0 - name: limit required: false in: query schema: minimum: 0 maximum: 1000 default: 10 type: number description: Maximum number of results to return. example: 10 responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: id: type: string entityOwnerId: anyOf: - type: string - type: 'null' tenantOwnerId: anyOf: - type: string - type: 'null' endpointUrl: type: string description: anyOf: - type: string - type: 'null' active: type: boolean eventTypes: type: array items: anyOf: - const: com.minespider.certificate.import.completed.v1 type: string - const: >- com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: >- com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string secretHint: type: string createdBy: description: >- Authenticated member ID for entity subscriptions; authenticated tenant ID for tenant subscriptions. type: string updatedBy: anyOf: - type: string - type: 'null' createdAt: type: number updatedAt: anyOf: - type: number - type: 'null' required: - id - entityOwnerId - tenantOwnerId - endpointUrl - description - active - eventTypes - secretHint - createdBy - updatedBy - createdAt - updatedAt required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityOwnerId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f tenantOwnerId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f endpointUrl: https://example.com/resource description: description active: true eventTypes: - com.minespider.certificate.import.completed.v1 secretHint: secret-hint createdBy: created-by updatedBy: updated-by createdAt: 0 updatedAt: 0 '400': description: Invalid pagination parameters or mixed page/size and offset/limit. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- WEBHOOKS feature and entity administrator credentials required; tenant impersonation and external tenant principals must use tenant webhook management. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '503': description: Webhooks are disabled. security: - bearer: [] - cookie: [] summary: List webhook subscriptions owned by the authenticated entity. tags: - Webhooks /v1/webhooks/{id}: patch: operationId: EntityWebhookController_update parameters: - name: id required: true in: path schema: type: string description: Webhook identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false minProperties: 1 type: object properties: endpointUrl: minLength: 1 maxLength: 2048 description: >- Public HTTPS URL. Changing it sends subsequent pending attempts to the new URL without resetting the deadline or replaying finished deliveries. Already in-flight requests may finish. type: string description: maxLength: 255 type: string eventTypes: minItems: 1 uniqueItems: true type: array items: anyOf: - const: com.minespider.certificate.import.completed.v1 type: string - const: com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string active: type: boolean example: endpointUrl: https://example.com/resource description: description eventTypes: - com.minespider.certificate.import.completed.v1 active: true description: Request payload for Update an entity webhook subscription. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: type: string entityOwnerId: anyOf: - type: string - type: 'null' tenantOwnerId: anyOf: - type: string - type: 'null' endpointUrl: type: string description: anyOf: - type: string - type: 'null' active: type: boolean eventTypes: type: array items: anyOf: - const: com.minespider.certificate.import.completed.v1 type: string - const: >- com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: >- com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string secretHint: type: string createdBy: description: >- Authenticated member ID for entity subscriptions; authenticated tenant ID for tenant subscriptions. type: string updatedBy: anyOf: - type: string - type: 'null' createdAt: type: number updatedAt: anyOf: - type: number - type: 'null' required: - id - entityOwnerId - tenantOwnerId - endpointUrl - description - active - eventTypes - secretHint - createdBy - updatedBy - createdAt - updatedAt required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityOwnerId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f tenantOwnerId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f endpointUrl: https://example.com/resource description: description active: true eventTypes: - com.minespider.certificate.import.completed.v1 secretHint: secret-hint createdBy: created-by updatedBy: updated-by createdAt: 0 updatedAt: 0 '400': description: Invalid patch fields/events or destination URL. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- WEBHOOKS feature and entity administrator credentials required; tenant impersonation and external tenant principals must use tenant webhook management. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: Subscription not found in the authenticated owner scope. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '422': description: Body does not match the patch schema. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 422 errorCode: 0 messages: - The request failed validation. content: null '503': description: Webhooks are disabled. security: - bearer: [] - cookie: [] summary: Update an entity webhook subscription. tags: - Webhooks /v1/webhooks/{id}/secret/rotate: post: description: >- The previous secret is deleted immediately. Subsequent attempts use the new secret. Update the receiver; requests already in flight may carry the old signature. operationId: EntityWebhookController_rotate parameters: - name: id required: true in: path schema: type: string description: Webhook identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object allOf: - type: object properties: id: type: string entityOwnerId: anyOf: - type: string - type: 'null' tenantOwnerId: anyOf: - type: string - type: 'null' endpointUrl: type: string description: anyOf: - type: string - type: 'null' active: type: boolean eventTypes: type: array items: anyOf: - const: >- com.minespider.certificate.import.completed.v1 type: string - const: >- com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: >- com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string secretHint: type: string createdBy: description: >- Authenticated member ID for entity subscriptions; authenticated tenant ID for tenant subscriptions. type: string updatedBy: anyOf: - type: string - type: 'null' createdAt: type: number updatedAt: anyOf: - type: number - type: 'null' required: - id - entityOwnerId - tenantOwnerId - endpointUrl - description - active - eventTypes - secretHint - createdBy - updatedBy - createdAt - updatedAt - type: object properties: secret: type: string required: - secret required: - _meta - messages - content '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- WEBHOOKS feature and entity administrator credentials required; tenant impersonation and external tenant principals must use tenant webhook management. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: Subscription not found in the authenticated owner scope. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '409': description: The secret was rotated by a concurrent request. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 409 errorCode: 0 messages: - The request conflicts with the current resource state. content: null '503': description: Webhooks are disabled. security: - bearer: [] - cookie: [] summary: Rotate an entity webhook signing secret. tags: - Webhooks /v1/webhooks/{id}/deliveries: get: operationId: EntityWebhookController_deliveries parameters: - name: id required: true in: path schema: type: string description: Webhook identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: page required: false in: query schema: minimum: 1 default: 1 description: One-based page. Use page/size or offset/limit, never both. type: number description: One-based page. Use page/size or offset/limit, never both. example: 1 - name: size required: false in: query schema: exclusiveMinimum: 0 maximum: 1000 default: 10 type: number description: Number of results per page. example: 10 - name: offset required: false in: query schema: minimum: 0 default: 0 description: Zero-based offset; alternative to page/size. type: number description: Zero-based offset; alternative to page/size. example: 0 - name: limit required: false in: query schema: minimum: 0 maximum: 1000 default: 10 type: number description: Maximum number of results to return. example: 10 responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: id: type: string eventId: type: string destinationUrl: description: >- Immutable original destination recorded when the delivery was created, retained for audit. Each attempt records its actual destination separately. type: string status: anyOf: - const: pending type: string - const: processing type: string - const: delivered type: string - const: exhausted type: string - const: cancelled type: string nextAttemptAt: anyOf: - type: number - type: 'null' deliveredAt: anyOf: - type: number - type: 'null' exhaustedAt: anyOf: - type: number - type: 'null' attemptHistory: type: array items: type: object properties: destinationUrl: description: Actual URL used by this attempt. type: string attempt: minimum: 1 description: One-based attempt number. type: integer at: description: Attempt start, Unix milliseconds. type: number durationMs: type: number httpStatus: description: >- Receiver HTTP response; absent for transport failure. type: integer errorCode: description: >- Sanitized transport error code; no receiver response body. type: string required: - destinationUrl - attempt - at - durationMs createdAt: type: number updatedAt: anyOf: - type: number - type: 'null' event: type: object properties: eventType: anyOf: - const: >- com.minespider.certificate.import.completed.v1 type: string - const: >- com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: >- com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string sourceQueue: type: string sourceJobId: type: string terminalStatus: anyOf: - const: completed type: string - const: failed type: string occurredAt: type: number required: - eventType - sourceQueue - sourceJobId - terminalStatus - occurredAt required: - id - eventId - destinationUrl - status - nextAttemptAt - deliveredAt - exhaustedAt - attemptHistory - createdAt - updatedAt - event required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f eventId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f destinationUrl: https://example.com/resource status: pending nextAttemptAt: 0 deliveredAt: 0 exhaustedAt: 0 attemptHistory: - destinationUrl: https://example.com/resource attempt: 1 at: 0 durationMs: 0 createdAt: 0 updatedAt: 0 event: eventType: com.minespider.certificate.import.completed.v1 sourceQueue: source-queue sourceJobId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f terminalStatus: completed occurredAt: 0 '400': description: Invalid pagination parameters or mixed page/size and offset/limit. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- WEBHOOKS feature and entity administrator credentials required; tenant impersonation and external tenant principals must use tenant webhook management. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: Subscription not found in the authenticated owner scope. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '503': description: Webhooks are disabled. security: - bearer: [] - cookie: [] summary: >- Read the last seven days of deliveries for an entity webhook subscription. tags: - Webhooks /v1/tenancy/tenants/{tenant}/webhooks: post: operationId: TenantWebhookController_create parameters: - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false type: object properties: endpointUrl: minLength: 1 maxLength: 2048 type: string description: maxLength: 255 type: string eventTypes: minItems: 1 uniqueItems: true type: array items: anyOf: - const: com.minespider.certificate.import.completed.v1 type: string - const: com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string required: - endpointUrl - eventTypes example: endpointUrl: https://example.com/resource description: description eventTypes: - com.minespider.certificate.import.completed.v1 description: Request payload for Create a tenant webhook subscription. responses: '201': description: Resource created successfully. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 201 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object allOf: - type: object properties: id: type: string entityOwnerId: anyOf: - type: string - type: 'null' tenantOwnerId: anyOf: - type: string - type: 'null' endpointUrl: type: string description: anyOf: - type: string - type: 'null' active: type: boolean eventTypes: type: array items: anyOf: - const: >- com.minespider.certificate.import.completed.v1 type: string - const: >- com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: >- com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string secretHint: type: string createdBy: description: >- Authenticated member ID for entity subscriptions; authenticated tenant ID for tenant subscriptions. type: string updatedBy: anyOf: - type: string - type: 'null' createdAt: type: number updatedAt: anyOf: - type: number - type: 'null' required: - id - entityOwnerId - tenantOwnerId - endpointUrl - description - active - eventTypes - secretHint - createdBy - updatedBy - createdAt - updatedAt - type: object properties: secret: type: string required: - secret required: - _meta - messages - content '400': description: >- Invalid fields/events or URL: HTTPS with public DNS/IP addresses and no credentials required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- Use the matching active tenant secret as Bearer credential; user and impersonation tokens are not tenant management credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '422': description: Body does not match the subscription schema. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 422 errorCode: 0 messages: - The request failed validation. content: null '503': description: Webhooks are disabled. security: - bearer: [] - cookie: [] summary: Create a tenant webhook subscription. tags: - Tenant Webhooks get: operationId: TenantWebhookController_list parameters: - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant - name: page required: false in: query schema: minimum: 1 default: 1 description: One-based page. Use page/size or offset/limit, never both. type: number description: One-based page. Use page/size or offset/limit, never both. example: 1 - name: size required: false in: query schema: exclusiveMinimum: 0 maximum: 1000 default: 10 type: number description: Number of results per page. example: 10 - name: offset required: false in: query schema: minimum: 0 default: 0 description: Zero-based offset; alternative to page/size. type: number description: Zero-based offset; alternative to page/size. example: 0 - name: limit required: false in: query schema: minimum: 0 maximum: 1000 default: 10 type: number description: Maximum number of results to return. example: 10 responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: id: type: string entityOwnerId: anyOf: - type: string - type: 'null' tenantOwnerId: anyOf: - type: string - type: 'null' endpointUrl: type: string description: anyOf: - type: string - type: 'null' active: type: boolean eventTypes: type: array items: anyOf: - const: com.minespider.certificate.import.completed.v1 type: string - const: >- com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: >- com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string secretHint: type: string createdBy: description: >- Authenticated member ID for entity subscriptions; authenticated tenant ID for tenant subscriptions. type: string updatedBy: anyOf: - type: string - type: 'null' createdAt: type: number updatedAt: anyOf: - type: number - type: 'null' required: - id - entityOwnerId - tenantOwnerId - endpointUrl - description - active - eventTypes - secretHint - createdBy - updatedBy - createdAt - updatedAt required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityOwnerId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f tenantOwnerId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f endpointUrl: https://example.com/resource description: description active: true eventTypes: - com.minespider.certificate.import.completed.v1 secretHint: secret-hint createdBy: created-by updatedBy: updated-by createdAt: 0 updatedAt: 0 '400': description: Invalid pagination parameters or mixed page/size and offset/limit. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- Use the matching active tenant secret as Bearer credential; user and impersonation tokens are not tenant management credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '503': description: Webhooks are disabled. security: - bearer: [] - cookie: [] summary: List webhook subscriptions owned by the authenticated tenant. tags: - Tenant Webhooks /v1/tenancy/tenants/{tenant}/webhooks/{id}: patch: operationId: TenantWebhookController_update parameters: - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant - name: id required: true in: path schema: type: string description: Webhook identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false minProperties: 1 type: object properties: endpointUrl: minLength: 1 maxLength: 2048 description: >- Public HTTPS URL. Changing it sends subsequent pending attempts to the new URL without resetting the deadline or replaying finished deliveries. Already in-flight requests may finish. type: string description: maxLength: 255 type: string eventTypes: minItems: 1 uniqueItems: true type: array items: anyOf: - const: com.minespider.certificate.import.completed.v1 type: string - const: com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string active: type: boolean example: endpointUrl: https://example.com/resource description: description eventTypes: - com.minespider.certificate.import.completed.v1 active: true description: Request payload for Update a tenant webhook subscription. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: type: string entityOwnerId: anyOf: - type: string - type: 'null' tenantOwnerId: anyOf: - type: string - type: 'null' endpointUrl: type: string description: anyOf: - type: string - type: 'null' active: type: boolean eventTypes: type: array items: anyOf: - const: com.minespider.certificate.import.completed.v1 type: string - const: >- com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: >- com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string secretHint: type: string createdBy: description: >- Authenticated member ID for entity subscriptions; authenticated tenant ID for tenant subscriptions. type: string updatedBy: anyOf: - type: string - type: 'null' createdAt: type: number updatedAt: anyOf: - type: number - type: 'null' required: - id - entityOwnerId - tenantOwnerId - endpointUrl - description - active - eventTypes - secretHint - createdBy - updatedBy - createdAt - updatedAt required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f entityOwnerId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f tenantOwnerId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f endpointUrl: https://example.com/resource description: description active: true eventTypes: - com.minespider.certificate.import.completed.v1 secretHint: secret-hint createdBy: created-by updatedBy: updated-by createdAt: 0 updatedAt: 0 '400': description: Invalid patch fields/events or destination URL. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- Use the matching active tenant secret as Bearer credential; user and impersonation tokens are not tenant management credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: Subscription not found in the authenticated owner scope. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '422': description: Body does not match the patch schema. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 422 errorCode: 0 messages: - The request failed validation. content: null '503': description: Webhooks are disabled. security: - bearer: [] - cookie: [] summary: Update a tenant webhook subscription. tags: - Tenant Webhooks /v1/tenancy/tenants/{tenant}/webhooks/{id}/secret/rotate: post: description: >- The previous secret is deleted immediately. Subsequent attempts use the new secret. Update the receiver; requests already in flight may carry the old signature. operationId: TenantWebhookController_rotate parameters: - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant - name: id required: true in: path schema: type: string description: Webhook identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object allOf: - type: object properties: id: type: string entityOwnerId: anyOf: - type: string - type: 'null' tenantOwnerId: anyOf: - type: string - type: 'null' endpointUrl: type: string description: anyOf: - type: string - type: 'null' active: type: boolean eventTypes: type: array items: anyOf: - const: >- com.minespider.certificate.import.completed.v1 type: string - const: >- com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: >- com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string secretHint: type: string createdBy: description: >- Authenticated member ID for entity subscriptions; authenticated tenant ID for tenant subscriptions. type: string updatedBy: anyOf: - type: string - type: 'null' createdAt: type: number updatedAt: anyOf: - type: number - type: 'null' required: - id - entityOwnerId - tenantOwnerId - endpointUrl - description - active - eventTypes - secretHint - createdBy - updatedBy - createdAt - updatedAt - type: object properties: secret: type: string required: - secret required: - _meta - messages - content '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- Use the matching active tenant secret as Bearer credential; user and impersonation tokens are not tenant management credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: Subscription not found in the authenticated owner scope. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '409': description: The secret was rotated by a concurrent request. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 409 errorCode: 0 messages: - The request conflicts with the current resource state. content: null '503': description: Webhooks are disabled. security: - bearer: [] - cookie: [] summary: Rotate a tenant webhook signing secret. tags: - Tenant Webhooks /v1/tenancy/tenants/{tenant}/webhooks/{id}/deliveries: get: operationId: TenantWebhookController_deliveries parameters: - name: tenant required: true in: path schema: type: string description: Tenant identifier. example: tenant - name: id required: true in: path schema: type: string description: Webhook identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: page required: false in: query schema: minimum: 1 default: 1 description: One-based page. Use page/size or offset/limit, never both. type: number description: One-based page. Use page/size or offset/limit, never both. example: 1 - name: size required: false in: query schema: exclusiveMinimum: 0 maximum: 1000 default: 10 type: number description: Number of results per page. example: 10 - name: offset required: false in: query schema: minimum: 0 default: 0 description: Zero-based offset; alternative to page/size. type: number description: Zero-based offset; alternative to page/size. example: 0 - name: limit required: false in: query schema: minimum: 0 maximum: 1000 default: 10 type: number description: Maximum number of results to return. example: 10 responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: id: type: string eventId: type: string destinationUrl: description: >- Immutable original destination recorded when the delivery was created, retained for audit. Each attempt records its actual destination separately. type: string status: anyOf: - const: pending type: string - const: processing type: string - const: delivered type: string - const: exhausted type: string - const: cancelled type: string nextAttemptAt: anyOf: - type: number - type: 'null' deliveredAt: anyOf: - type: number - type: 'null' exhaustedAt: anyOf: - type: number - type: 'null' attemptHistory: type: array items: type: object properties: destinationUrl: description: Actual URL used by this attempt. type: string attempt: minimum: 1 description: One-based attempt number. type: integer at: description: Attempt start, Unix milliseconds. type: number durationMs: type: number httpStatus: description: >- Receiver HTTP response; absent for transport failure. type: integer errorCode: description: >- Sanitized transport error code; no receiver response body. type: string required: - destinationUrl - attempt - at - durationMs createdAt: type: number updatedAt: anyOf: - type: number - type: 'null' event: type: object properties: eventType: anyOf: - const: >- com.minespider.certificate.import.completed.v1 type: string - const: >- com.minespider.certificate.batch.publish.completed.v1 type: string - const: >- com.minespider.certificate.batch.deprecate.completed.v1 type: string - const: >- com.minespider.certificate.batch.duplicate.completed.v1 type: string - const: >- com.minespider.certificate.batch.patch.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.grant.completed.v1 type: string - const: >- com.minespider.certificate.acl.batch.revoke.completed.v1 type: string sourceQueue: type: string sourceJobId: type: string terminalStatus: anyOf: - const: completed type: string - const: failed type: string occurredAt: type: number required: - eventType - sourceQueue - sourceJobId - terminalStatus - occurredAt required: - id - eventId - destinationUrl - status - nextAttemptAt - deliveredAt - exhaustedAt - attemptHistory - createdAt - updatedAt - event required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f eventId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f destinationUrl: https://example.com/resource status: pending nextAttemptAt: 0 deliveredAt: 0 exhaustedAt: 0 attemptHistory: - destinationUrl: https://example.com/resource attempt: 1 at: 0 durationMs: 0 createdAt: 0 updatedAt: 0 event: eventType: com.minespider.certificate.import.completed.v1 sourceQueue: source-queue sourceJobId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f terminalStatus: completed occurredAt: 0 '400': description: Invalid pagination parameters or mixed page/size and offset/limit. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- Use the matching active tenant secret as Bearer credential; user and impersonation tokens are not tenant management credentials. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: Subscription not found in the authenticated owner scope. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '503': description: Webhooks are disabled. security: - bearer: [] - cookie: [] summary: >- Read the last seven days of deliveries for a tenant webhook subscription. tags: - Tenant Webhooks /v1/supply-chain/analytics/reporting/export-bundle: get: description: >- Returns the certificate facts needed to recalculate the Reporting filters inside a self-contained HTML export. Metadata keys are paths from the selected passport template; dynamic field keys are paths marked with `x-dynamic-data: true`. Battery passport example: `GET /v1/supply-chain/analytics/reporting/export-bundle?type=battery-passport&metadataKey=batteryCarbonFootprint.batteryCarbonFootprintPerFunctionalUnit&manufacturingDateKey=identifiersAndProductData.productData.manufacturingDate&dynamicFieldKeys=performanceAndDurability.capacity%2CEnergy%2CAndVoltage.stateOfCharge%28soc%29&startTimestamp=1781308800&endTimestamp=1783900800` operationId: AnalyticsController_reportingExportBundle parameters: - name: type required: true in: query schema: anyOf: - const: product-passport type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: metadataKey required: true in: query schema: minLength: 1 maxLength: 512 description: >- Certificate metadata key used as the report's primary metric. Use a key from the selected passport template; matching values are returned in the metadata collection for offline aggregation. example: batteryCarbonFootprint.batteryCarbonFootprintPerFunctionalUnit type: string description: >- Certificate metadata key used as the report's primary metric. Use a key from the selected passport template; matching values are returned in the metadata collection for offline aggregation. example: batteryCarbonFootprint.batteryCarbonFootprintPerFunctionalUnit - name: startTimestamp required: true in: query schema: description: Unix timestamp in seconds. pattern: ^[0-9]{10}$ type: string description: Unix timestamp in seconds. example: '1767225600' - name: endTimestamp required: true in: query schema: description: Unix timestamp in seconds. pattern: ^[0-9]{10}$ type: string description: Unix timestamp in seconds. example: '1767225600' - name: manufacturingDateKey required: false in: query schema: minLength: 1 maxLength: 512 description: >- Optional certificate metadata key containing an ISO 8601 manufacturing date. It is separate from metadataKey because it is an auxiliary grouping dimension, used to build the manufacturing-year distribution rather than the report's primary metric. Omit it when that distribution is not needed. example: identifiersAndProductData.productData.manufacturingDate type: string description: >- Optional certificate metadata key containing an ISO 8601 manufacturing date. It is separate from metadataKey because it is an auxiliary grouping dimension, used to build the manufacturing-year distribution rather than the report's primary metric. Omit it when that distribution is not needed. example: identifiersAndProductData.productData.manufacturingDate - name: dynamicFieldKeys required: false in: query schema: minItems: 1 maxItems: 100 uniqueItems: true description: >- Dynamic numeric time-series fields to include in dynamicFields and dynamicValues. Every key must be available for the selected passport type. Send multiple values as repeated dynamicFieldKeys query parameters. example: - >- performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc) - >- performanceAndDurability.temperatureConditions.temperatureInformation type: array items: minLength: 1 maxLength: 512 description: >- Canonical dot-joined path of a field marked with x-dynamic-data: true in the active template schema. example: >- performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc) type: string description: >- Dynamic numeric time-series fields to include in dynamicFields and dynamicValues. Every key must be available for the selected passport type. Send multiple values as repeated dynamicFieldKeys query parameters. example: - >- performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc) - >- performanceAndDurability.temperatureConditions.temperatureInformation responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: version: const: 1 type: number entityId: type: string type: anyOf: - const: product-passport type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string startTimestamp: type: number endTimestamp: type: number labels: type: array items: type: object properties: id: type: string name: type: string required: - id - name entities: type: array items: type: object properties: id: type: string name: anyOf: - type: string - type: 'null' city: anyOf: - type: string - type: 'null' country: anyOf: - type: string - type: 'null' latitude: anyOf: - minimum: -90 maximum: 90 type: number - type: 'null' longitude: anyOf: - minimum: -180 maximum: 180 type: number - type: 'null' required: - id - name - city - country - latitude - longitude certificates: type: array items: type: object properties: id: type: string code: type: string createdAt: type: number status: type: string ownerEntityId: type: string recipientEntityId: anyOf: - type: string - type: 'null' recipientName: anyOf: - type: string - type: 'null' labelIds: type: array items: type: string required: - id - code - createdAt - status - ownerEntityId - recipientEntityId - recipientName - labelIds metadata: type: array items: type: object properties: certificateId: type: string key: type: string value: type: string required: - certificateId - key - value materials: type: array items: type: object properties: certificateId: type: string materialId: type: string material: type: string materialTypeId: type: string amount: type: number required: - certificateId - materialId - material - materialTypeId - amount dynamicFields: type: array items: type: object properties: key: type: string label: type: string type: type: string unit: type: string required: - key - label - type dynamicValues: type: array items: type: object properties: certificateId: type: string timestamp: type: number fieldKey: type: string value: type: number required: - certificateId - timestamp - fieldKey - value required: - version - entityId - type - startTimestamp - endTimestamp - labels - entities - certificates - metadata - materials - dynamicFields - dynamicValues required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: version: 1 entityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f type: product-passport startTimestamp: 0 endTimestamp: 0 labels: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name entities: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name city: city country: country latitude: -90 longitude: -180 certificates: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f code: ABC123 createdAt: 0 status: published ownerEntityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f recipientEntityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f recipientName: recipient-name labelIds: - label-ids metadata: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key value: example-value materials: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f materialId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f material: material materialTypeId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f amount: 0 dynamicFields: - key: metadata.key label: label type: product-passport dynamicValues: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f timestamp: 0 fieldKey: metadata.key value: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: >- Build an authorized offline Reporting data bundle for the current entity. tags: - Supply Chain Analytics /v1/supply-chain/analytics/certificates: get: description: >- Analytics is calculated based on the applied filters to the certificate collection. Query parameters for filtering are the same as those used for fetching certificates. The analytics contains the following information: pending (count of draft or ready certificates), published (count of published certificates), and my (count of all shipment certificates except deprecated). operationId: AnalyticsController_getCertificatesAnalytics parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: status required: false in: query schema: type: string description: Filter by lifecycle status. example: published - name: parent required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: relates required: false in: query schema: anyOf: - const: me type: string - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Relates value used by this operation. example: me - name: label required: false in: query schema: type: string description: Label value used by this operation. example: label - name: owner required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Owner value used by this operation. example: owner - name: recipient required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Recipient value used by this operation. example: recipient - name: amountType required: false in: query schema: type: string description: Amount type value used by this operation. example: product-passport - name: material required: false in: query schema: type: string description: Material value used by this operation. example: material - name: measurementType required: false in: query schema: type: string description: Measurement type value used by this operation. example: product-passport - name: materialAmount required: false in: query schema: type: string description: Material amount value used by this operation. example: material-amount - name: createdAt required: false in: query schema: type: string description: Filter by creation timestamp. example: created-at - name: createdBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Created by value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: standard required: false in: query schema: type: string description: Standard value used by this operation. example: standard responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate analytics type: object properties: pending: description: Amount of pending certificates example: 3 type: number published: description: Amount of published certificates example: 43 type: number my: description: Amount of my certificates example: 13 type: number required: - pending - published - my required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: pending: 3 published: 43 my: 13 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: >- Retrieve the certificates analytics calculation for the current logged-in user. tags: - Supply Chain Analytics /v1/supply-chain/analytics/materials: get: description: >- Analytics is calculated based on the applied filters to the certificate collection. Query parameters for filtering are the same as those used for fetching certificates. The analytics contains an array of used materials in the current entity, grouped by material. operationId: AnalyticsController_getMaterialsAnalytics parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: status required: false in: query schema: type: string description: Filter by lifecycle status. example: published - name: parent required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Parent value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: relates required: false in: query schema: anyOf: - const: me type: string - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Relates value used by this operation. example: me - name: label required: false in: query schema: type: string description: Label value used by this operation. example: label - name: owner required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Owner value used by this operation. example: owner - name: recipient required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Recipient value used by this operation. example: recipient - name: amountType required: false in: query schema: type: string description: Amount type value used by this operation. example: product-passport - name: material required: false in: query schema: type: string description: Material value used by this operation. example: material - name: measurementType required: false in: query schema: type: string description: Measurement type value used by this operation. example: product-passport - name: materialAmount required: false in: query schema: type: string description: Material amount value used by this operation. example: material-amount - name: createdAt required: false in: query schema: type: string description: Filter by creation timestamp. example: created-at - name: createdBy required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Created by value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: standard required: false in: query schema: type: string description: Standard value used by this operation. example: standard responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Material analytics type: object properties: amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material name example: Butan type: string materialType: description: Material type name example: Liquids/Gases type: string type: description: Measurement type name example: Volume type: string required: - amountSI - material - materialType - type required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - amountSI: 0.003 material: Butan materialType: Liquids/Gases type: Volume '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: >- Retrieve the materials analytics calculation of product-passports for the current logged-in user. tags: - Supply Chain Analytics /v1/supply-chain/analytics/inventory: get: description: Analytics supports search on the material name field. operationId: AnalyticsController_getInventoryAnalytics parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: inventory: type: array items: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type name example: Liquids/Gases type: string left: description: Amount of material left example: 12 type: number used: description: Amount of material used example: 3 type: number required: - id - ownedBy - name - default - type - left - used overview: type: object properties: all: description: Number of all materials example: 21 type: number custom: description: >- Number of custom materials, created by current entity example: 5 type: number required: - all - custom required: - inventory - overview required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: inventory: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Butan default: false type: Liquids/Gases left: 12 used: 3 overview: all: 21 custom: 5 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve the calculation of material inventory analytics. tags: - Supply Chain Analytics /v1/supply-chain/analytics/dashboard: get: description: >- Fetches the overall analytics dashboard, providing an overview of key metrics and insights related to the system's performance and data. operationId: AnalyticsController_dashboard parameters: [] responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve the analytics dashboard. tags: - Supply Chain Analytics /v1/supply-chain/analytics/passports/totals: get: description: >- Returns aggregate passport counts for the caller's entity after applying type, status, ownership scope, label, and date-range filters. operationId: AnalyticsController_passportsTotals parameters: - name: status required: false in: query schema: anyOf: - pattern: >- ^\s*(?:draft|ready|published|deprecated)(?:\s*,\s*(?:draft|ready|published|deprecated))*\s*$ maxLength: 128 description: Certificate statuses as one value or a comma-separated list. type: string - minItems: 1 maxItems: 4 uniqueItems: true type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string description: Filter by lifecycle status. example: published - name: type required: false in: query schema: anyOf: - pattern: >- ^\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport)(?:\s*,\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport))*\s*$ maxLength: 256 description: Certificate types as one value or a comma-separated list. type: string - minItems: 1 maxItems: 8 uniqueItems: true type: array items: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: scope required: false in: query schema: description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. default: both anyOf: - const: sender type: string - const: recipient type: string - const: both type: string description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. example: both - name: label required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate label UUID owned by the authenticated entity. description: Certificate label UUID owned by the authenticated entity. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: materialId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID linked to the filtered passports. description: Material UUID linked to the filtered passports. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: startTimestamp required: false in: query schema: description: Inclusive start timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1781308800' type: string description: Inclusive start timestamp as Unix seconds since epoch. example: '1781308800' - name: endTimestamp required: false in: query schema: description: Exclusive end timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1783900800' type: string description: Exclusive end timestamp as Unix seconds since epoch. example: '1783900800' responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Passports totals analytics type: object properties: count: description: Total number of passports in the selected window example: 100 type: number required: - count required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: count: 100 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Passports totals (average & sum) for current entity. tags: - Supply Chain Analytics /v1/supply-chain/analytics/passports/timeseries: get: description: >- Returns time-bucketed passport totals for the caller's entity using the requested interval and passport filters. operationId: AnalyticsController_passportsTotalsOverTime parameters: - name: status required: false in: query schema: anyOf: - pattern: >- ^\s*(?:draft|ready|published|deprecated)(?:\s*,\s*(?:draft|ready|published|deprecated))*\s*$ maxLength: 128 description: Certificate statuses as one value or a comma-separated list. type: string - minItems: 1 maxItems: 4 uniqueItems: true type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string description: Filter by lifecycle status. example: published - name: type required: false in: query schema: anyOf: - pattern: >- ^\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport)(?:\s*,\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport))*\s*$ maxLength: 256 description: Certificate types as one value or a comma-separated list. type: string - minItems: 1 maxItems: 8 uniqueItems: true type: array items: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: scope required: false in: query schema: description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. default: both anyOf: - const: sender type: string - const: recipient type: string - const: both type: string description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. example: both - name: label required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate label UUID owned by the authenticated entity. description: Certificate label UUID owned by the authenticated entity. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: materialId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID linked to the filtered passports. description: Material UUID linked to the filtered passports. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: startTimestamp required: false in: query schema: description: Inclusive start timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1781308800' type: string description: Inclusive start timestamp as Unix seconds since epoch. example: '1781308800' - name: endTimestamp required: false in: query schema: description: Exclusive end timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1783900800' type: string description: Exclusive end timestamp as Unix seconds since epoch. example: '1783900800' - name: interval required: false in: query schema: description: Time bucketing interval default: month anyOf: - const: hour type: string - const: day type: string - const: month type: string - const: year type: string description: Time bucketing interval example: month responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Passports time-series analytics type: array items: description: Passports time-series point type: object properties: date: description: Bucket start date (YYYY-MM-DD) example: '2025-08-01' type: string count: description: Number of passports in this bucket example: 24 type: number required: - date - count required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - date: '2025-08-01' count: 24 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Passports totals (average & sum) for current entity over time. tags: - Supply Chain Analytics /v1/supply-chain/analytics/metadata/totals: get: description: >- Aggregates values for the requested metadata key across passports visible in the caller's entity and selected filters. operationId: AnalyticsController_metadataTotals parameters: - name: status required: false in: query schema: anyOf: - pattern: >- ^\s*(?:draft|ready|published|deprecated)(?:\s*,\s*(?:draft|ready|published|deprecated))*\s*$ maxLength: 128 description: Certificate statuses as one value or a comma-separated list. type: string - minItems: 1 maxItems: 4 uniqueItems: true type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string description: Filter by lifecycle status. example: published - name: type required: false in: query schema: anyOf: - pattern: >- ^\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport)(?:\s*,\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport))*\s*$ maxLength: 256 description: Certificate types as one value or a comma-separated list. type: string - minItems: 1 maxItems: 8 uniqueItems: true type: array items: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: scope required: false in: query schema: description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. default: both anyOf: - const: sender type: string - const: recipient type: string - const: both type: string description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. example: both - name: label required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate label UUID owned by the authenticated entity. description: Certificate label UUID owned by the authenticated entity. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: materialId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID linked to the filtered passports. description: Material UUID linked to the filtered passports. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: startTimestamp required: false in: query schema: description: Inclusive start timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1781308800' type: string description: Inclusive start timestamp as Unix seconds since epoch. example: '1781308800' - name: endTimestamp required: false in: query schema: description: Exclusive end timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1783900800' type: string description: Exclusive end timestamp as Unix seconds since epoch. example: '1783900800' - name: metadataKey required: true in: query schema: description: Metadata key to aggregate/filter analytics on. type: string description: Metadata key to aggregate/filter analytics on. example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Metadata totals analytics type: object properties: average: description: >- Global average of the metadata values in the selected window example: 10.2 type: number sum: description: >- Global sum of the metadata values in the selected window example: 240.5 type: number required: - average - sum required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: average: 10.2 sum: 240.5 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Metadata totals (average & sum) for current entity. tags: - Supply Chain Analytics /v1/supply-chain/analytics/metadata/timeseries: get: description: >- Returns time-bucketed aggregates for the requested metadata key using the selected interval and passport filters. operationId: AnalyticsController_metadataTotalsOverTime parameters: - name: status required: false in: query schema: anyOf: - pattern: >- ^\s*(?:draft|ready|published|deprecated)(?:\s*,\s*(?:draft|ready|published|deprecated))*\s*$ maxLength: 128 description: Certificate statuses as one value or a comma-separated list. type: string - minItems: 1 maxItems: 4 uniqueItems: true type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string description: Filter by lifecycle status. example: published - name: type required: false in: query schema: anyOf: - pattern: >- ^\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport)(?:\s*,\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport))*\s*$ maxLength: 256 description: Certificate types as one value or a comma-separated list. type: string - minItems: 1 maxItems: 8 uniqueItems: true type: array items: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: scope required: false in: query schema: description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. default: both anyOf: - const: sender type: string - const: recipient type: string - const: both type: string description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. example: both - name: label required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate label UUID owned by the authenticated entity. description: Certificate label UUID owned by the authenticated entity. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: materialId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID linked to the filtered passports. description: Material UUID linked to the filtered passports. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: startTimestamp required: false in: query schema: description: Inclusive start timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1781308800' type: string description: Inclusive start timestamp as Unix seconds since epoch. example: '1781308800' - name: endTimestamp required: false in: query schema: description: Exclusive end timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1783900800' type: string description: Exclusive end timestamp as Unix seconds since epoch. example: '1783900800' - name: interval required: false in: query schema: description: Time bucketing interval default: month anyOf: - const: hour type: string - const: day type: string - const: month type: string - const: year type: string description: Time bucketing interval example: month - name: metadataKey required: true in: query schema: description: Metadata key to aggregate/filter analytics on. type: string description: Metadata key to aggregate/filter analytics on. example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Metadata time-series analytics type: array items: description: Metadata time-series point type: object properties: date: description: Bucket start date (YYYY-MM-DD) example: '2025-08-01' type: string count: description: Number of records contributing to this bucket example: 12 type: number average: description: Average of metadata values within this bucket example: 10.2 type: number sum: description: Sum of metadata values within this bucket example: 24 type: number required: - date - count - average - sum required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - date: '2025-08-01' count: 12 average: 10.2 sum: 24 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Metadata totals (average & sum) for current entity over time. tags: - Supply Chain Analytics /v1/supply-chain/analytics/materials/distribution: get: description: >- Returns the material distribution across passports visible in the caller's entity after applying the passport filters. operationId: AnalyticsController_materialsDistribution parameters: - name: status required: false in: query schema: anyOf: - pattern: >- ^\s*(?:draft|ready|published|deprecated)(?:\s*,\s*(?:draft|ready|published|deprecated))*\s*$ maxLength: 128 description: Certificate statuses as one value or a comma-separated list. type: string - minItems: 1 maxItems: 4 uniqueItems: true type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string description: Filter by lifecycle status. example: published - name: type required: false in: query schema: anyOf: - pattern: >- ^\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport)(?:\s*,\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport))*\s*$ maxLength: 256 description: Certificate types as one value or a comma-separated list. type: string - minItems: 1 maxItems: 8 uniqueItems: true type: array items: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: scope required: false in: query schema: description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. default: both anyOf: - const: sender type: string - const: recipient type: string - const: both type: string description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. example: both - name: label required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate label UUID owned by the authenticated entity. description: Certificate label UUID owned by the authenticated entity. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: materialId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID linked to the filtered passports. description: Material UUID linked to the filtered passports. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: startTimestamp required: false in: query schema: description: Inclusive start timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1781308800' type: string description: Inclusive start timestamp as Unix seconds since epoch. example: '1781308800' - name: endTimestamp required: false in: query schema: description: Exclusive end timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1783900800' type: string description: Exclusive end timestamp as Unix seconds since epoch. example: '1783900800' responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Materials distribution analytics type: array items: description: Per-material usage distribution type: object properties: materialId: description: Material ID type: string material: description: Material name type: string count: description: Distinct certificates using this material type: number sum: description: Total amountSI used type: number required: - materialId - material - count - sum required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - materialId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f material: material count: 0 sum: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Materials used by certificates (distribution). tags: - Supply Chain Analytics /v1/supply-chain/analytics/recipients/distribution: get: description: >- Returns recipient distribution and entity details across passports visible in the caller's entity and selected filters. operationId: AnalyticsController_recipientsDistribution parameters: - name: status required: false in: query schema: anyOf: - pattern: >- ^\s*(?:draft|ready|published|deprecated)(?:\s*,\s*(?:draft|ready|published|deprecated))*\s*$ maxLength: 128 description: Certificate statuses as one value or a comma-separated list. type: string - minItems: 1 maxItems: 4 uniqueItems: true type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string description: Filter by lifecycle status. example: published - name: type required: false in: query schema: anyOf: - pattern: >- ^\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport)(?:\s*,\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport))*\s*$ maxLength: 256 description: Certificate types as one value or a comma-separated list. type: string - minItems: 1 maxItems: 8 uniqueItems: true type: array items: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: scope required: false in: query schema: description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. default: both anyOf: - const: sender type: string - const: recipient type: string - const: both type: string description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. example: both - name: label required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate label UUID owned by the authenticated entity. description: Certificate label UUID owned by the authenticated entity. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: materialId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID linked to the filtered passports. description: Material UUID linked to the filtered passports. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: startTimestamp required: false in: query schema: description: Inclusive start timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1781308800' type: string description: Inclusive start timestamp as Unix seconds since epoch. example: '1781308800' - name: endTimestamp required: false in: query schema: description: Exclusive end timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1783900800' type: string description: Exclusive end timestamp as Unix seconds since epoch. example: '1783900800' responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: entity: type: object properties: id: type: string name: anyOf: - type: string - type: 'null' email: anyOf: - type: string - type: 'null' required: - id - name - email count: type: number required: - entity - count required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name email: developer@example.com count: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: >- Recipients of certificates (distribution) with entity details for current entity. tags: - Supply Chain Analytics /v1/supply-chain/analytics/counterparties/locations: get: description: >- Returns geographic counterparty counts for filtered passports. The REPORTING feature must be enabled for the caller's entity. operationId: AnalyticsController_counterpartyLocations parameters: - name: status required: false in: query schema: anyOf: - pattern: >- ^\s*(?:draft|ready|published|deprecated)(?:\s*,\s*(?:draft|ready|published|deprecated))*\s*$ maxLength: 128 description: Certificate statuses as one value or a comma-separated list. type: string - minItems: 1 maxItems: 4 uniqueItems: true type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string description: Filter by lifecycle status. example: published - name: type required: false in: query schema: anyOf: - pattern: >- ^\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport)(?:\s*,\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport))*\s*$ maxLength: 256 description: Certificate types as one value or a comma-separated list. type: string - minItems: 1 maxItems: 8 uniqueItems: true type: array items: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: scope required: false in: query schema: description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. default: both anyOf: - const: sender type: string - const: recipient type: string - const: both type: string description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. example: both - name: label required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate label UUID owned by the authenticated entity. description: Certificate label UUID owned by the authenticated entity. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: materialId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID linked to the filtered passports. description: Material UUID linked to the filtered passports. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: startTimestamp required: false in: query schema: description: Inclusive start timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1781308800' type: string description: Inclusive start timestamp as Unix seconds since epoch. example: '1781308800' - name: endTimestamp required: false in: query schema: description: Exclusive end timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1783900800' type: string description: Exclusive end timestamp as Unix seconds since epoch. example: '1783900800' responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: totalEntities: type: number mappedEntities: type: number locations: type: array items: type: object properties: entity: type: object properties: id: type: string name: anyOf: - type: string - type: 'null' city: anyOf: - type: string - type: 'null' country: anyOf: - type: string - type: 'null' required: - id - name - city - country latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number count: type: number required: - entity - latitude - longitude - count required: - totalEntities - mappedEntities - locations required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: totalEntities: 0 mappedEntities: 0 locations: - entity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name city: city country: country latitude: -90 longitude: -180 count: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Counterparty locations across filtered passports for the current entity. tags: - Supply Chain Analytics /v1/supply-chain/analytics/dynamic-data/timeseries: post: description: >- Receives schema-keyed certificate dynamic data rows and stores them in ClickHouse. Use canonical Battery Passport metadata keys from the active template schema as values keys. Dynamic fields are marked with x-dynamic-data: true in GET /v1/template/templates?type=BatteryPassport&default=true&active=true&status=published. Values must match the schema field type; enum fields must use one of the schema enum values. Dynamic fields cannot be created or updated through metadata endpoints. operationId: AnalyticsController_ingestCertificateDynamicDataTimeseries parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: >- Payload for ingesting schema-keyed certificate dynamic data. Maximum 5000 rows per request and 100 dynamic fields per row. maxItems: 5000 example: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f timestamp: '2026-06-13T10:30:00Z' values: identifiersAndProductData.productData.batteryStatus: Original performanceAndDurability.capacity,Energy,AndVoltage.remainingCapacity: 82 performanceAndDurability.capacity,Energy,AndVoltage.remainingUsableBatteryEnergy: 64 performanceAndDurability.capacity,Energy,AndVoltage.stateOfCertifiedEnergy(soce): 91.4 performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc): 74.6 performanceAndDurability.powerCapability.remainingPowerCapability: 150000 performanceAndDurability.roundTripEnergyEfficiencyAndSelf-discharge.remainingRoundTripEnergyEfficiency_: 93.2 "performanceAndDurability.roundTripEnergyEfficiency\nandSelf-discharge.currentSelf-dischargeRate": 1.2 "performanceAndDurability.roundTripEnergyEfficiency\nandSelf-discharge.evolutionOfSelf-dischargeRates": 0.4 performanceAndDurability.batteryLifetime.numberOfFullChargingAndDischargingCycles: 120 performanceAndDurability.batteryLifetime.energyThroughput__: 18450.5 performanceAndDurability.batteryLifetime.capacityThroughput__: 24010.75 performanceAndDurability.temperatureConditions.temperatureInformation: 23 performanceAndDurability.temperatureConditions.timeSpentInExtremeTemperaturesAboveBoundary: 15 performanceAndDurability.temperatureConditions.timeSpentInExtremeTemperaturesBelowBoundary: 0 performanceAndDurability.temperatureConditions.timeSpentChargingDuringExtremeTemperaturesAboveBoundary: 4 performanceAndDurability.temperatureConditions.timeSpentChargingDuringExtremeTemperaturesBelowBoundary: 0 performanceAndDurability.negativeEvents.numberOfDeepDischargeEvents: 1 performanceAndDurability.negativeEvents.numberOfOverchargeEvents: 0 performanceAndDurability.negativeEvents.informationOnAccidents: No accidents reported type: array items: description: >- One timestamped set of dynamic values for a certificate. A row may contain one or many dynamic fields. example: certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f timestamp: '2026-06-13T10:30:00Z' values: identifiersAndProductData.productData.batteryStatus: Original performanceAndDurability.capacity,Energy,AndVoltage.remainingCapacity: 82 performanceAndDurability.capacity,Energy,AndVoltage.remainingUsableBatteryEnergy: 64 performanceAndDurability.capacity,Energy,AndVoltage.stateOfCertifiedEnergy(soce): 91.4 performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc): 74.6 performanceAndDurability.powerCapability.remainingPowerCapability: 150000 performanceAndDurability.roundTripEnergyEfficiencyAndSelf-discharge.remainingRoundTripEnergyEfficiency_: 93.2 "performanceAndDurability.roundTripEnergyEfficiency\nandSelf-discharge.currentSelf-dischargeRate": 1.2 "performanceAndDurability.roundTripEnergyEfficiency\nandSelf-discharge.evolutionOfSelf-dischargeRates": 0.4 performanceAndDurability.batteryLifetime.numberOfFullChargingAndDischargingCycles: 120 performanceAndDurability.batteryLifetime.energyThroughput__: 18450.5 performanceAndDurability.batteryLifetime.capacityThroughput__: 24010.75 performanceAndDurability.temperatureConditions.temperatureInformation: 23 performanceAndDurability.temperatureConditions.timeSpentInExtremeTemperaturesAboveBoundary: 15 performanceAndDurability.temperatureConditions.timeSpentInExtremeTemperaturesBelowBoundary: 0 performanceAndDurability.temperatureConditions.timeSpentChargingDuringExtremeTemperaturesAboveBoundary: 4 performanceAndDurability.temperatureConditions.timeSpentChargingDuringExtremeTemperaturesBelowBoundary: 0 performanceAndDurability.negativeEvents.numberOfDeepDischargeEvents: 1 performanceAndDurability.negativeEvents.numberOfOverchargeEvents: 0 performanceAndDurability.negativeEvents.informationOnAccidents: No accidents reported type: object properties: certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID owned by the authenticated entity. timestamp: description: >- Measurement timestamp for the dynamic values. Send the real measurement time, not the upload time. Accepted format: ISO 8601 date-time, for example 2026-06-13T10:30:00Z. example: '2026-06-13T10:30:00Z' type: string values: description: >- Object keyed by canonical Battery Passport dynamic field keys. Dynamic fields are not updated through metadata endpoints; send them here. maxProperties: 100 example: identifiersAndProductData.productData.batteryStatus: Original performanceAndDurability.capacity,Energy,AndVoltage.remainingCapacity: 82 performanceAndDurability.capacity,Energy,AndVoltage.remainingUsableBatteryEnergy: 64 performanceAndDurability.capacity,Energy,AndVoltage.stateOfCertifiedEnergy(soce): 91.4 performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc): 74.6 performanceAndDurability.powerCapability.remainingPowerCapability: 150000 performanceAndDurability.roundTripEnergyEfficiencyAndSelf-discharge.remainingRoundTripEnergyEfficiency_: 93.2 "performanceAndDurability.roundTripEnergyEfficiency\nandSelf-discharge.currentSelf-dischargeRate": 1.2 "performanceAndDurability.roundTripEnergyEfficiency\nandSelf-discharge.evolutionOfSelf-dischargeRates": 0.4 performanceAndDurability.batteryLifetime.numberOfFullChargingAndDischargingCycles: 120 performanceAndDurability.batteryLifetime.energyThroughput__: 18450.5 performanceAndDurability.batteryLifetime.capacityThroughput__: 24010.75 performanceAndDurability.temperatureConditions.temperatureInformation: 23 performanceAndDurability.temperatureConditions.timeSpentInExtremeTemperaturesAboveBoundary: 15 performanceAndDurability.temperatureConditions.timeSpentInExtremeTemperaturesBelowBoundary: 0 performanceAndDurability.temperatureConditions.timeSpentChargingDuringExtremeTemperaturesAboveBoundary: 4 performanceAndDurability.temperatureConditions.timeSpentChargingDuringExtremeTemperaturesBelowBoundary: 0 performanceAndDurability.negativeEvents.numberOfDeepDischargeEvents: 1 performanceAndDurability.negativeEvents.numberOfOverchargeEvents: 0 performanceAndDurability.negativeEvents.informationOnAccidents: No accidents reported type: object patternProperties: ^[\s\S]*$: description: >- Dynamic field value. Send a JSON value that matches the field type from the active Battery Passport schema: string, number, boolean, object, or array. Enum fields must use one of the enum values from the schema. example: 74.6 required: - certificateId - timestamp - values example: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f timestamp: '2026-06-13T10:30:00Z' values: identifiersAndProductData.productData.batteryStatus: Original performanceAndDurability.capacity,Energy,AndVoltage.remainingCapacity: 82 performanceAndDurability.capacity,Energy,AndVoltage.remainingUsableBatteryEnergy: 64 performanceAndDurability.capacity,Energy,AndVoltage.stateOfCertifiedEnergy(soce): 91.4 performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc): 74.6 performanceAndDurability.powerCapability.remainingPowerCapability: 150000 performanceAndDurability.roundTripEnergyEfficiencyAndSelf-discharge.remainingRoundTripEnergyEfficiency_: 93.2 "performanceAndDurability.roundTripEnergyEfficiency\nandSelf-discharge.currentSelf-dischargeRate": 1.2 "performanceAndDurability.roundTripEnergyEfficiency\nandSelf-discharge.evolutionOfSelf-dischargeRates": 0.4 performanceAndDurability.batteryLifetime.numberOfFullChargingAndDischargingCycles: 120 performanceAndDurability.batteryLifetime.energyThroughput__: 18450.5 performanceAndDurability.batteryLifetime.capacityThroughput__: 24010.75 performanceAndDurability.temperatureConditions.temperatureInformation: 23 performanceAndDurability.temperatureConditions.timeSpentInExtremeTemperaturesAboveBoundary: 15 performanceAndDurability.temperatureConditions.timeSpentInExtremeTemperaturesBelowBoundary: 0 performanceAndDurability.temperatureConditions.timeSpentChargingDuringExtremeTemperaturesAboveBoundary: 4 performanceAndDurability.temperatureConditions.timeSpentChargingDuringExtremeTemperaturesBelowBoundary: 0 performanceAndDurability.negativeEvents.numberOfDeepDischargeEvents: 1 performanceAndDurability.negativeEvents.numberOfOverchargeEvents: 0 performanceAndDurability.negativeEvents.informationOnAccidents: No accidents reported description: Request payload for Ingest certificate dynamic data time series. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- Result of certificate dynamic data ingest with per-value errors type: object properties: inserted: description: >- Number of dynamic field values inserted into ClickHouse. example: 20 type: number rejected: description: Number of rejected rows or field values. example: 0 type: number errors: description: >- Per-row or per-field validation errors. Valid values in the same request can still be inserted. type: array items: description: Error for a rejected certificate dynamic data value type: object properties: certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID for the rejected row or value. fieldKey: description: Dynamic field key that was rejected. type: string reason: description: Reason why the row or value was rejected. example: >- Dynamic field value is not one of the allowed enum values type: string required: - certificateId - reason required: - inserted - rejected - errors required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: inserted: 20 rejected: 0 errors: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f reason: >- Dynamic field value is not one of the allowed enum values '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Ingest certificate dynamic data time series. tags: - Supply Chain Analytics get: description: >- Returns numeric certificate dynamic data aggregated from certificate_dynamic_values for charting. Use type=battery-passport for Battery Passports. Status values are draft, ready, published, deprecated. Type values are product-passport, battery-passport, pv-passport, simplified-pv-passport, batch-passport, material-passport, tyre-passport, entity. Use repeated fieldKeys query parameters when a dynamic field key contains commas. operationId: AnalyticsController_certificateDynamicDataTimeseries parameters: - name: status required: false in: query schema: anyOf: - pattern: >- ^\s*(?:draft|ready|published|deprecated)(?:\s*,\s*(?:draft|ready|published|deprecated))*\s*$ maxLength: 128 description: Certificate statuses as one value or a comma-separated list. type: string - minItems: 1 maxItems: 4 uniqueItems: true type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string - const: deprecated type: string description: Filter by lifecycle status. example: published - name: type required: false in: query schema: anyOf: - pattern: >- ^\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport)(?:\s*,\s*(?:product-passport|entity|battery-passport|pv-passport|simplified-pv-passport|batch-passport|material-passport|tyre-passport))*\s*$ maxLength: 256 description: Certificate types as one value or a comma-separated list. type: string - minItems: 1 maxItems: 8 uniqueItems: true type: array items: anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: scope required: false in: query schema: description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. default: both anyOf: - const: sender type: string - const: recipient type: string - const: both type: string description: >- Scope of certificates relative to the authenticated entity: sender matches ownerEntityId, recipient matches recipientEntityId, and both matches either. example: both - name: label required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate label UUID owned by the authenticated entity. description: Certificate label UUID owned by the authenticated entity. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateIds required: false in: query schema: description: >- Certificate UUIDs as a comma-separated string or repeated query parameters. anyOf: - description: >- Certificate UUIDs as a comma-separated string or repeated query parameters. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 2000 type: string - maxItems: 50 type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 512 type: string description: >- Certificate UUIDs as a comma-separated string or repeated query parameters. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: materialIds required: false in: query schema: description: >- Material UUIDs as a comma-separated string or repeated query parameters. anyOf: - description: >- Material UUIDs as a comma-separated string or repeated query parameters. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 2000 type: string - maxItems: 50 type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 512 type: string description: >- Material UUIDs as a comma-separated string or repeated query parameters. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: fieldKeys required: false in: query schema: description: >- Dynamic field keys to include in the time-series response. Use keys from the active template schema. anyOf: - description: >- One dynamic field key. Use repeated fieldKeys query parameters when keys contain commas. Field keys are dot-joined template schema paths marked with x-dynamic-data: true. example: >- performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc) maxLength: 512 type: string - maxItems: 20 description: >- Dynamic field keys as repeated query parameters. Recommended when keys contain commas. example: - >- performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc) - >- performanceAndDurability.temperatureConditions.temperatureInformation type: array items: example: >- performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc) maxLength: 512 type: string description: >- Dynamic field keys to include in the time-series response. Use keys from the active template schema. example: >- performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc) - name: interval required: false in: query schema: description: Time bucketing interval default: month anyOf: - const: hour type: string - const: day type: string - const: month type: string - const: year type: string description: Time bucketing interval example: month - name: startTimestamp required: false in: query schema: description: Inclusive start timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1781308800' type: string description: Inclusive start timestamp as Unix seconds since epoch. example: '1781308800' - name: endTimestamp required: false in: query schema: description: Exclusive end timestamp as Unix seconds since epoch. pattern: ^[0-9]{10}$ example: '1783900800' type: string description: Exclusive end timestamp as Unix seconds since epoch. example: '1783900800' responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- Schema-keyed certificate dynamic data time-series. Only numeric dynamic fields are returned for charting. type: object properties: fields: type: array items: type: object properties: key: description: >- Canonical Battery Passport schema field key. Use the same dot-joined key used for certificate metadata. Get the current schema with GET /v1/template/templates?type=BatteryPassport&default=true&active=true&status=published and send fields marked with "x-dynamic-data": true. example: >- performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc) type: string label: description: >- Human-readable field label from the active template schema. example: State of Charge ( So C) type: string type: description: JSON schema type for the dynamic field. example: number type: string unit: description: Unit from the template schema, when available. example: '%' type: string required: - key - label - type points: type: array items: type: object properties: timestamp: description: Start timestamp of the aggregation bucket. example: '2026-06-13 00:00:00' type: string values: description: >- Numeric dynamic values keyed by schema field key. Values are averaged inside the selected interval bucket. example: performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc): 74.6 type: object patternProperties: ^(.*)$: anyOf: - type: number - type: 'null' required: - timestamp - values required: - fields - points required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: fields: - key: >- performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc) label: State of Charge ( So C) type: number points: - timestamp: '2026-06-13 00:00:00' values: performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc): 74.6 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Certificate dynamic data time series. tags: - Supply Chain Analytics /v1/supply-chain/analytics/dynamic-data/latest: get: description: >- Returns the latest ClickHouse dynamic values by certificate ID and canonical schema field key. Latest is selected by the dynamic value measurement timestamp. If multiple rows have the same timestamp, the later received row wins. operationId: AnalyticsController_latestCertificateDynamicData parameters: - name: certificateIds required: true in: query schema: description: >- Certificate UUIDs to read. Send as a comma-separated string or repeated query parameter. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f anyOf: - type: string - type: array items: type: string description: >- Certificate UUIDs to read. Send as a comma-separated string or repeated query parameter. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- Latest dynamic values by certificate. Only certificates owned by the caller are returned. type: array items: type: object properties: certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID. values: description: >- Latest dynamic values keyed by canonical Battery Passport schema field key. example: performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc): value: 74.6 timestamp: '2026-06-13T10:30:00.000Z' source: clickhouse type: object patternProperties: ^(.*)$: type: object properties: value: description: >- Dynamic field value. Send a JSON value that matches the field type from the active Battery Passport schema: string, number, boolean, object, or array. Enum fields must use one of the enum values from the schema. example: 74.6 timestamp: description: >- ISO 8601 UTC measurement timestamp of the latest dynamic value. example: '2026-06-13T10:30:00.000Z' type: string source: description: Source storage for the dynamic value. example: clickhouse const: clickhouse type: string required: - value - timestamp - source required: - certificateId - values required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f values: performanceAndDurability.capacity,Energy,AndVoltage.stateOfCharge(soc): value: 74.6 timestamp: '2026-06-13T10:30:00.000Z' source: clickhouse '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Latest certificate dynamic data values. tags: - Supply Chain Analytics /v1/supply-chain/attachments/previous: get: description: Fetches a collection of files associated with the logged user's entity. operationId: AttachmentController_getAll parameters: - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: order required: false in: query schema: type: string description: Result ordering expression. example: createdAt:desc responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: >- Certificate attachment. Either a new file can be uploaded, or an existing S3 bucket path can be provided. type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Attachment UUID filename: description: User defined attachment filename example: Regulation document type: string path: description: Bucket storage filename example: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca type: string title: description: Attachment title example: Battery passport regulations in EU countries type: string checksum: description: Hashed value of file content example: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 type: string visibilityLayer: description: Attachment visibility layer example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string certId: description: Attachment certificate UUID type: string mimeType: description: Attachment file mimeType example: application/pdf type: string originalFilename: description: Attachment original filename example: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf type: string encoding: description: Attachment file encoding example: 7bit type: string size: description: Attachment file size example: 160459 type: number file: pattern: ^https?://\S+$ description: Publicly accessible URL for the file example: >- https://assets.minespider.com/uploads/1234-5678/report.pdf type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - filename - path - title - checksum - visibilityLayer - certId - mimeType - originalFilename - encoding - size - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f filename: Regulation document path: >- 0xa0fca6b7e6ccd18af6b22e05a1b76ec38e34fe42f4b1b185973e20a9438fe7ca title: Battery passport regulations in EU countries checksum: 993c760ee6f30bf3a6ec0cffd7051604ceb51cf0 visibilityLayer: public certId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f mimeType: application/pdf originalFilename: BN81-20142A-02_WEB_G55T_CIS_210730.0.pdf encoding: 7bit size: 160459 createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve the collection of files related to the logged user's entity. tags: - Passport Attachments /v1/supply-chain/certificates/{certificateId}/disqualifications: post: description: >- Associates a disqualification status with a specific certificate, indicating it no longer meets the required criteria. operationId: DisqualificationController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Create disqualification body schema type: object properties: reportText: minLength: 10 maxLength: 100000 description: Disqualification report text example: Incorrect material origin information type: string required: - reportText example: reportText: Incorrect material origin information description: Request payload for Create a certificate disqualification. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate disqualification type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification UUID reportText: description: Disqualification report text example: Request to edit product passport details type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification owner entity UUID certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification certificate UUID createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - reportText - ownedBy - certificateId - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f reportText: Request to edit product passport details ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a certificate disqualification. tags: - Passport Disqualifications get: description: Fetches all disqualifications associated with a specific certificate. operationId: DisqualificationController_find parameters: - name: order required: false in: query schema: description: Defines the sorting order example: '-createdAt' type: string description: Defines the sorting order example: '-createdAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Certificate disqualification type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification UUID reportText: description: Disqualification report text example: Request to edit product passport details type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification owner entity UUID certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification certificate UUID createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - reportText - ownedBy - certificateId - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f reportText: Request to edit product passport details ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve a certificate disqualification collection. tags: - Passport Disqualifications /v1/supply-chain/certificates/{certificateId}/disqualifications/{id}: delete: description: >- Removes a disqualification status from a specific certificate, revalidating it if necessary. operationId: DisqualificationController_remove parameters: - name: id required: true in: path schema: type: string description: Disqualification identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a certificate disqualification. tags: - Passport Disqualifications get: description: >- Retrieves a specific certificate disqualification using its unique identifier. operationId: DisqualificationController_findOne parameters: - name: id required: true in: path schema: type: string description: Disqualification identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate disqualification type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification UUID reportText: description: Disqualification report text example: Request to edit product passport details type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification owner entity UUID certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification certificate UUID createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - reportText - ownedBy - certificateId - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f reportText: Request to edit product passport details ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get a certificate disqualification by id. tags: - Passport Disqualifications patch: description: Modifies the details of an existing certificate disqualification. operationId: DisqualificationController_update parameters: - name: id required: true in: path schema: type: string description: Disqualification identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Update disqualification body schema type: object properties: reportText: minLength: 10 maxLength: 100000 description: Disqualification report text example: Updated material origin information type: string required: - reportText example: reportText: Updated material origin information description: Request payload for Update a certificate disqualification. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate disqualification type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification UUID reportText: description: Disqualification report text example: Request to edit product passport details type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification owner entity UUID certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Disqualification certificate UUID createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - reportText - ownedBy - certificateId - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f reportText: Request to edit product passport details ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Update a certificate disqualification. tags: - Passport Disqualifications /v1/supply-chain/certificates/{certificateId}/events: post: description: Creates a new event related to a certificate. operationId: CertificateEventController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Create certificate event body schema type: object properties: type: description: Event type const: repair type: string description: minLength: 1 maxLength: 275 description: Event description type: string responsiblePerson: minLength: 1 maxLength: 255 description: Responsible person type: string attachments: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Storage file UUID required: - description - responsiblePerson example: type: repair description: description responsiblePerson: responsible-person attachments: - 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: Request payload for Create a certificate event. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate event type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Event UUID certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID certificateVersion: minimum: 0 description: Certificate version number example: 0 type: number type: description: Event type example: repair const: repair type: string description: description: Event description maxLength: 275 type: string responsiblePerson: description: Responsible person maxLength: 255 type: string createdByEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Creator entity UUID attachments: type: array items: description: Storage file summary type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID name: description: File name type: string title: description: File title type: string mime: description: File mime type type: string size: description: File size type: number visibility: description: File visibility example: private anyOf: - const: public type: string - const: private type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID uri: pattern: ^https?://\S+$ description: String representation of file URI type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - title - mime - size - visibility - ownedBy - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certificateId - certificateVersion - type - description - responsiblePerson - createdByEntityId - attachments - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateVersion: 0 type: repair description: description responsiblePerson: responsible-person createdByEntityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f attachments: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name title: title mime: mime size: 0 visibility: private ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a certificate event. tags: - Passport Events get: description: Retrieves a collection of events associated with a certificate. operationId: CertificateEventController_list parameters: - name: order required: false in: query schema: description: Defines the sorting order example: '-createdAt' type: string description: Defines the sorting order example: '-createdAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: type required: false in: query schema: const: repair type: string description: Type value used by this operation. example: repair - name: createdByEntityId required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Created by entity id value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: version required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Version value used by this operation. example: version - name: createdAt required: false in: query schema: description: >- Date filter for creation time. Supported formats: - single timestamp in epoch ms (e.g. "1596240000000") to match exactly. - range "startEpochMs,endEpochMs" (both in epoch ms). - open-ended ranges: ",endEpochMs" or "startEpochMs," (omit start or end). type: string description: >- Date filter for creation time. Supported formats: - single timestamp in epoch ms (e.g. "1596240000000") to match exactly. - range "startEpochMs,endEpochMs" (both in epoch ms). - open-ended ranges: ",endEpochMs" or "startEpochMs," (omit start or end). example: created-at - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Certificate event type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Event UUID certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID certificateVersion: minimum: 0 description: Certificate version number example: 0 type: number type: description: Event type example: repair const: repair type: string description: description: Event description maxLength: 275 type: string responsiblePerson: description: Responsible person maxLength: 255 type: string createdByEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Creator entity UUID attachments: type: array items: description: Storage file summary type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID name: description: File name type: string title: description: File title type: string mime: description: File mime type type: string size: description: File size type: number visibility: description: File visibility example: private anyOf: - const: public type: string - const: private type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID uri: pattern: ^https?://\S+$ description: String representation of file URI type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - title - mime - size - visibility - ownedBy - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certificateId - certificateVersion - type - description - responsiblePerson - createdByEntityId - attachments - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateVersion: 0 type: repair description: description responsiblePerson: responsible-person createdByEntityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f attachments: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name title: title mime: mime size: 0 visibility: private ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: List certificate events. tags: - Passport Events /v1/supply-chain/certificates/{certificateId}/events/{id}: get: description: Retrieves a specific event associated with a certificate. operationId: CertificateEventController_getOne parameters: - name: id required: true in: path schema: type: string description: Event identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate event type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Event UUID certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID certificateVersion: minimum: 0 description: Certificate version number example: 0 type: number type: description: Event type example: repair const: repair type: string description: description: Event description maxLength: 275 type: string responsiblePerson: description: Responsible person maxLength: 255 type: string createdByEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Creator entity UUID attachments: type: array items: description: Storage file summary type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID name: description: File name type: string title: description: File title type: string mime: description: File mime type type: string size: description: File size type: number visibility: description: File visibility example: private anyOf: - const: public type: string - const: private type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID uri: pattern: ^https?://\S+$ description: String representation of file URI type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - title - mime - size - visibility - ownedBy - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certificateId - certificateVersion - type - description - responsiblePerson - createdByEntityId - attachments - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateVersion: 0 type: repair description: description responsiblePerson: responsible-person createdByEntityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f attachments: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name title: title mime: mime size: 0 visibility: private ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get a certificate event. tags: - Passport Events patch: description: Updates an existing event related to a certificate. operationId: CertificateEventController_update parameters: - name: id required: true in: path schema: type: string description: Event identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: minProperties: 1 description: Update certificate event body schema type: object properties: description: minLength: 1 maxLength: 275 description: Event description type: string responsiblePerson: minLength: 1 maxLength: 255 description: Responsible person type: string attachments: description: Attachment changes type: object properties: add: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Storage file UUID remove: type: array items: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Storage file UUID example: description: description responsiblePerson: responsible-person attachments: add: - 4ac55d01-ec52-499e-9bc3-b5d648ffd88f remove: - 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: Request payload for Update a certificate event. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate event type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Event UUID certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID certificateVersion: minimum: 0 description: Certificate version number example: 0 type: number type: description: Event type example: repair const: repair type: string description: description: Event description maxLength: 275 type: string responsiblePerson: description: Responsible person maxLength: 255 type: string createdByEntityId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Creator entity UUID attachments: type: array items: description: Storage file summary type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID name: description: File name type: string title: description: File title type: string mime: description: File mime type type: string size: description: File size type: number visibility: description: File visibility example: private anyOf: - const: public type: string - const: private type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Owner entity UUID uri: pattern: ^https?://\S+$ description: String representation of file URI type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - title - mime - size - visibility - ownedBy - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - certificateId - certificateVersion - type - description - responsiblePerson - createdByEntityId - attachments - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateVersion: 0 type: repair description: description responsiblePerson: responsible-person createdByEntityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f attachments: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name title: title mime: mime size: 0 visibility: private ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Update a certificate event. tags: - Passport Events delete: description: Removes an event associated with a certificate. operationId: CertificateEventController_remove parameters: - name: id required: true in: path schema: type: string description: Event identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a certificate event. tags: - Passport Events /v1/supply-chain/certificates/{certificateId}/events/{id}/attachments/{fileId}/download: get: description: Streams an attachment associated with a certificate event. operationId: CertificateEventController_downloadAttachment parameters: - name: id required: true in: path schema: type: string description: Event identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: fileId required: true in: path schema: type: string description: File identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Download an event attachment. tags: - Passport Events /v1/supply-chain/labels: post: description: >- Adds a new label to a specific certificate for categorization or identification purposes. operationId: LabelController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: description: Label creation body schema type: object properties: name: minLength: 1 description: Name of the label example: Label type: string collection: description: >- Collection of labels/tags. Possible values 'ProductPassport' and 'EntityCertificate' const: Certificate type: string required: - name - collection example: name: Label collection: Certificate description: Request payload for Create certificate label. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create certificate label. tags: - Labels get: description: Fetches all labels associated with a specific certificate. operationId: LabelController_findMany parameters: - name: order required: false in: query schema: type: string description: Result ordering expression. example: createdAt:desc - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: name required: false in: query schema: description: Name of the label/tag type: string description: Name of the label/tag example: name - name: collection required: false in: query schema: description: >- Collection of labels/tags. Possible values 'ProductPassport' and 'EntityCertificate' const: Certificate type: string description: >- Collection of labels/tags. Possible values 'ProductPassport' and 'EntityCertificate' example: Certificate - name: certificateType required: false in: query schema: description: Only labels attached to certificates of this type anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Only labels attached to certificates of this type example: product-passport responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve certificate labels collection. tags: - Labels /v1/supply-chain/labels/{id}: get: description: >- Retrieves a specific label associated with a certificate using its unique identifier. operationId: LabelController_findOne parameters: - name: id required: true in: path schema: type: string description: Label identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get certificate label by id. tags: - Labels patch: description: >- Modifies the details of an existing label associated with a specific certificate. operationId: LabelController_update parameters: - name: id required: true in: path schema: type: string description: Label identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: minProperties: 1 description: Label updation body schema type: object properties: name: minLength: 1 description: Name of the label example: Label type: string collection: description: >- Collection of labels/tags. Possible values 'ProductPassport' and 'EntityCertificate' const: Certificate type: string example: name: Label collection: Certificate description: Request payload for Patch certificate label. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Patch certificate label. tags: - Labels delete: description: Removes a label associated with a specific certificate. operationId: LabelController_remove parameters: - name: id required: true in: path schema: type: string description: Label identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete certificate label. tags: - Labels /v1/supply-chain/certificates/{certificateId}/metadata: post: description: >- Adds new metadata to a certificate, enhancing the details associated with it. operationId: MetadataController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Create metadata body schema type: object properties: key: minLength: 1 maxLength: 10000 type: string value: minLength: 0 maxLength: 100000 type: string description: >- Metadata value. Scalar Battery Passport URI document fields accept an HTTP(S) URL or a private upload ID from POST /storage/file. Upload IDs are persisted and returned as passport-scoped download URLs. type: description: Metadata type example: string type: string format: description: Metadata format example: string type: string order: description: Defines the sorting order example: -1 type: number visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string required: - key - value - visibilityLayer example: key: metadata.key value: example-value type: string format: string order: -1 visibilityLayer: public description: description description: Request payload for Create a certificate metadata. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key value: example-value order: -1 type: product-passport certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f visibilityLayer: transparent createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a certificate metadata. tags: - Passport Metadata get: description: Fetches the entire collection of metadata associated with certificates. operationId: MetadataController_find parameters: - name: key required: false in: query schema: minLength: 1 maxLength: 10000 description: Metadata key example: Metadata type: string description: Metadata key example: Metadata - name: value required: false in: query schema: minLength: 0 maxLength: 100000 description: Metadata value example: Some metadata type: string description: Metadata value example: Some metadata - name: order required: false in: query schema: description: Defines the sorting order example: '-createdAt' type: string description: Defines the sorting order example: '-createdAt' - name: visibilityLayer required: false in: query schema: description: Metadata visibility layer. Possible values public and transparent example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: Metadata visibility layer. Possible values public and transparent example: public - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key value: example-value order: -1 type: product-passport certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f visibilityLayer: transparent createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: - {} - bearer: [] - cookie: [] summary: Retrieve certificate metadata collection tags: - Passport Metadata /v1/supply-chain/certificates/{certificateId}/metadata/batch: post: description: >- Adds multiple metadata entries to one or more certificates, enhancing the details associated with them. operationId: MetadataController_createMultipleMatadata parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Batch create metadata body schema type: array items: description: Create metadata body schema type: object properties: key: minLength: 1 maxLength: 10000 type: string value: minLength: 0 maxLength: 100000 type: string description: >- Metadata value. Scalar Battery Passport URI document fields accept an HTTP(S) URL or a private upload ID from POST /storage/file. Upload IDs are persisted and returned as passport-scoped download URLs. type: description: Metadata type example: string type: string format: description: Metadata format example: string type: string order: description: Defines the sorting order example: -1 type: number visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string required: - key - value - visibilityLayer example: - key: metadata.key value: example-value type: string format: string order: -1 visibilityLayer: public description: description description: Request payload for Create multiple certificate metadata. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key value: example-value order: -1 type: product-passport certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f visibilityLayer: transparent createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create multiple certificate metadata. tags: - Passport Metadata /v1/supply-chain/certificates/{certificateId}/metadata/{id}: patch: description: >- Updates the existing metadata for a certificate, modifying specific details as needed. operationId: MetadataController_update parameters: - name: id required: true in: path schema: type: string description: Metadata identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: minProperties: 1 description: Update metadata body schema type: object properties: key: minLength: 1 maxLength: 10000 description: Metadata key example: Metadata type: string value: minLength: 0 maxLength: 100000 description: >- Metadata value. Scalar Battery Passport URI document fields accept an HTTP(S) URL or a private upload ID from POST /storage/file. Upload IDs are persisted and returned as passport-scoped download URLs. example: Some metadata type: string order: description: Defines the sorting order example: -1 type: number type: description: Metadata type example: string type: string format: description: Metadata format example: string type: string visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent example: public anyOf: - const: transparent type: string - const: private type: string - const: public type: string example: key: Metadata value: Some metadata order: -1 type: string format: string visibilityLayer: public description: Request payload for Patch a certificate metadata. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key value: example-value order: -1 type: product-passport certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f visibilityLayer: transparent createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Patch a certificate metadata. tags: - Passport Metadata delete: description: Removes the metadata associated with a certificate. operationId: MetadataController_remove parameters: - name: id required: true in: path schema: type: string description: Metadata identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a certificate metadata. tags: - Passport Metadata get: description: >- Retrieves the metadata associated with a specific certificate using its unique identifier. operationId: MetadataController_findOne parameters: - name: id required: true in: path schema: type: string description: Metadata identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate metadata type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Metadata UUID key: description: Metadata key type: string value: description: >- Metadata value. Newly saved scalar Battery Passport document fields contain a URL (type string, format uri). Historical rows may still contain a legacy file ID. type: string order: description: Defines the sorting order example: -1 type: number type: type: string format: type: string certificateId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID to which this metadata is attached visibilityLayer: description: >- Metadata visibility layer. Possible values public and transparent anyOf: - const: transparent type: string - const: private type: string - const: public type: string description: description: Metadata description type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - key - value - order - type - certificateId - visibilityLayer - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f key: metadata.key value: example-value order: -1 type: product-passport certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f visibilityLayer: transparent createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: - {} - bearer: [] - cookie: [] summary: Get certificate metadata by id. tags: - Passport Metadata /v1/supply-chain/certificates/{certificateId}/metadata/{metadataId}/files/{fileId}: get: description: >- Returns the file ID, original filename, MIME type and size using the same passport-version, metadata-layer and ownership checks as the download route. Public fields are accessible anonymously; restricted fields require the appropriate layer permission. Returns 403 for denied layers, 401 for unauthenticated draft access and 404 for missing or mismatched references. Does not read file bytes or expose storage paths, checksums or URLs. operationId: MetadataFileController_findOne parameters: - name: metadataId required: true in: path schema: type: string description: Metadata identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: fileId required: true in: path schema: type: string description: File identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: File type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: File UUID name: minLength: 1 maxLength: 1000 description: File name example: Regulations type: string mime: description: Mime type of the file example: image/png type: string size: description: File size example: 23598 type: number required: - id - name - mime - size required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Regulations mime: image/png size: 23598 security: - {} - bearer: [] - cookie: [] summary: Retrieve the display details of a file referenced by passport metadata. tags: - Passport Metadata /v1/supply-chain/certificates/{certificateId}/metadata/{metadataId}/files/{fileId}/download: get: description: >- Streams a stored file referenced by the specified metadata row on this passport version. Public fields are accessible anonymously; restricted fields require the passport visibility-layer permission. Draft access follows passport read permissions. Returns 401 for unauthenticated draft access, 404 for missing or mismatched references and 403 for a denied layer. Stored file IDs, including legacy uploads, remain valid. No public storage URL is returned. operationId: MetadataFileController_download parameters: - name: metadataId required: true in: path schema: type: string description: Metadata identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: fileId required: true in: path schema: type: string description: File identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: The file contents, with the original filename. content: application/octet-stream: schema: type: string format: binary security: - {} - bearer: [] - cookie: [] summary: Download a file referenced by passport metadata. tags: - Passport Metadata /v1/supply-chain/certificates/{certificateId}/materials: post: description: Adds a new material associated with a certificate to the system. operationId: CertificateMaterialController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: description: Create certificate material body schema type: object properties: amount: anyOf: - minimum: -9007199254740991 maximum: 9007199254740991 default: 1 type: number - type: 'null' amountType: anyOf: - default: unit description: >- The unit of measurement for the amount. Also accepts 'un' as an alias for 'unit'. type: string - type: 'null' material: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - type: 'null' required: - material example: amount: 1 amountType: unit material: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f originCertificate: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: Request payload for Create a certificate material. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy certificate: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - certificate - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f amount: 3 amountType: l amountSI: 0.003 material: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Butan alias: butan active: true default: false type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificate: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a certificate material. tags: - Passport Materials get: description: Fetches all materials associated with a specific certificate. operationId: CertificateMaterialController_find parameters: - name: order required: false in: query schema: default: '-createdAt' type: string description: Result ordering expression. example: '-createdAt' - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: include required: false in: query schema: anyOf: - type: string - type: array items: type: string description: Related resources to include in the response. example: include - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy certificate: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - certificate - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f amount: 3 amountType: l amountSI: 0.003 material: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Butan alias: butan active: true default: false type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificate: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: - {} - bearer: [] - cookie: [] summary: Retrieve certificate materials collection. tags: - Passport Materials /v1/supply-chain/certificates/{certificateId}/materials/{id}: patch: description: Updates an existing material associated with a certificate. operationId: CertificateMaterialController_update parameters: - name: id required: true in: path schema: type: string description: Material identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: minProperties: 1 description: Patch certificate material body schema type: object properties: amount: minimum: -9007199254740991 maximum: 9007199254740991 type: number amountType: description: >- The unit of measurement for the amount. Also accepts 'un' as an alias for 'unit'. type: string material: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - type: 'null' originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - type: 'null' example: amount: -9007199254740991 amountType: product-passport material: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f originCertificate: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: Request payload for Patch a certificate material. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy certificate: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - certificate - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f amount: 3 amountType: l amountSI: 0.003 material: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Butan alias: butan active: true default: false type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificate: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Patch a certificate material. tags: - Passport Materials delete: description: >- Removes a material associated with a specific certificate from the system. operationId: CertificateMaterialController_remove parameters: - name: id required: true in: path schema: type: string description: Material identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a certificate material. tags: - Passport Materials get: description: Retrieves a specific certificate material using its unique identifier. operationId: CertificateMaterialController_findOne parameters: - name: id required: true in: path schema: type: string description: Material identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate material UUID amount: description: Material amount value example: 3 type: number amountType: description: Material measurement unit symbol example: l type: string amountSI: description: Material amount converted to SI value example: 0.003 type: number material: description: Material type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material owner entity UUID name: description: Materials name example: Butan type: string alias: description: Unique slug string of a material name example: butan type: string active: description: Whether the material is active or not example: true type: boolean default: description: >- Whether the material is default or not. Non default materials are custom materials created by users example: false type: boolean image: pattern: ^https?://\S+$ description: >- Image of the material to display. Should be uploaded to file management system first example: >- https://fra1.digitaloceanspaces.com/files.live.minespider.com/4746ddaa-3fb5-4133-a16d-b14857faf727 anyOf: - type: string - type: 'null' type: description: Material type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type UUID ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Material type owner entity UUID name: description: Material type name example: Liquids/Gases type: string active: description: Whether the material type is active or not example: true type: boolean default: description: >- Whether the material type is default or not. Non default material types are custom material types created by users example: false type: boolean measurementType: description: Measurement type type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Measurement type UUID name: description: Measurement type name example: Volume type: string active: description: >- Whether the measurement type is active or not example: true type: boolean default: description: >- Whether the measurement type is default or not. Non default measurement types are custom measurement types created by users example: false type: boolean createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - active - default - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - active - default - measurementType - createdAt - createdBy createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - ownedBy - name - alias - active - default - type - createdAt - createdBy certificate: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Certificate UUID originCertificate: anyOf: - type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string code: type: string type: type: string required: - id - code - type - type: 'null' createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - amount - amountType - amountSI - material - certificate - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f amount: 3 amountType: l amountSI: 0.003 material: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Butan alias: butan active: true default: false type: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Liquids/Gases active: true default: false measurementType: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Volume active: true default: false createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificate: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f security: - {} - bearer: [] - cookie: [] summary: Get a certificate material by id. tags: - Passport Materials /v1/supply-chain/tags: post: description: >- Creates a new tag that can be associated with certificates, materials, or other entities. operationId: TagController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: name: minLength: 1 description: Name of the label example: Label type: string collection: description: >- Collection of labels/tags. Possible values 'ProductPassport' and 'EntityCertificate' const: Certificate type: string required: - name - collection example: name: Label collection: Certificate description: Request payload for Create a tag responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a tag tags: - Tags get: description: Retrieves the collection of all tags available. operationId: TagController_findMany parameters: - name: order required: false in: query schema: type: string description: Result ordering expression. example: createdAt:desc - name: search required: false in: query schema: minLength: 0 maxLength: 255 description: Search filter example: search type: string description: Search filter example: search - name: name required: false in: query schema: description: Name of the label/tag type: string description: Name of the label/tag example: name - name: collection required: false in: query schema: description: >- Collection of labels/tags. Possible values 'ProductPassport' and 'EntityCertificate' const: Certificate type: string description: >- Collection of labels/tags. Possible values 'ProductPassport' and 'EntityCertificate' example: Certificate - name: certificateType required: false in: query schema: description: Only labels attached to certificates of this type anyOf: - const: product-passport type: string - const: entity type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Only labels attached to certificates of this type example: product-passport - name: availability required: false in: query schema: description: Filter by availability type: string description: Filter by availability example: availability responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve tags collection tags: - Tags /v1/supply-chain/tags/{id}: delete: description: >- Deletes a tag from the system, removing its association with any certificates, materials, or other entities. operationId: TagController_remove parameters: - name: id required: true in: path schema: type: string description: Tag identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a tag tags: - Tags patch: description: >- Updates the properties of an existing tag, allowing changes to its name, description, or other associated data. operationId: TagController_update parameters: - name: id required: true in: path schema: type: string description: Tag identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: name: minLength: 1 description: Name of the label example: Label type: string collection: description: >- Collection of labels/tags. Possible values 'ProductPassport' and 'EntityCertificate' const: Certificate type: string example: name: Label collection: Certificate description: Request payload for Patch a tag responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Patch a tag tags: - Tags get: description: Retrieves a specific tag using its unique identifier. operationId: TagController_findOne parameters: - name: id required: true in: path schema: type: string description: Tag identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get a tag by id tags: - Tags /v1/supply-chain/certificates/{certificateId}/labels: post: description: >- Generates and associates a label with a specific certificate to provide additional context or categorization. operationId: CertificateLabelController_create parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: minProperties: 1 description: Create certificate label body schema type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label/tag UUID name: minLength: 1 description: Name of the label example: Label type: string example: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Label description: Request payload for Create a label attached to the certificate. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a label attached to the certificate. tags: - Passport Labels get: description: Fetches all labels associated with a specific certificate. operationId: CertificateLabelController_findMany parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retrieve labels attached to the certificate. tags: - Passport Labels /v1/supply-chain/certificates/{certificateId}/labels/{id}: get: description: Fetches the label associated with a specific certificate. operationId: CertificateLabelController_findOne parameters: - name: id required: true in: path schema: type: string description: Label identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get a label attached to the certificate. tags: - Passport Labels delete: description: Removes a label associated with a specific certificate from the system. operationId: CertificateLabelController_delete parameters: - name: id required: true in: path schema: type: string description: Label identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a label attached to the certificate. tags: - Passport Labels /v1/supply-chain/certificates/{certificateId}/tags: post: description: >- Adds a new tag associated with a specific certificate for categorization or labeling. operationId: CertificateTagController_attach parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f requestBody: required: true content: application/json: schema: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label/tag UUID name: minLength: 1 description: Name of the label example: Label type: string example: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Label description: Request payload for Create a certificate tag. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a certificate tag. tags: - Passport Tags get: description: Adds a new tag to a specific certificate using its unique identifier. operationId: CertificateTagController_findMany parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create a certificate tag by id. tags: - Passport Tags /v1/supply-chain/certificates/{certificateId}/tags/{id}: get: description: Retrieves a specific tag associated with a certificate. operationId: CertificateTagController_findOne parameters: - name: id required: true in: path schema: type: string description: Tag identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Certificate label type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag UUID name: description: Label or tag name example: Agreements type: string alias: description: Unique slug string of an label or tag name example: agreements type: string ownedBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label or tag owner entity UUID collection: description: >- Label or tag collection. Currently supported value: Certificate example: Certificate const: Certificate type: string createdAt: description: Creation timestamp example: 1686042132022 anyOf: - type: number - type: integer createdBy: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: UUID of the member who created it. updatedAt: description: Updation timestamp example: null anyOf: - type: 'null' - type: number - type: integer updatedBy: description: UUID of the member who updated it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string deletedAt: description: Deletion timestamp example: null anyOf: - type: 'null' - type: number - type: integer deletedBy: description: UUID of the member who deleted it. example: null anyOf: - type: 'null' - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string required: - id - name - alias - ownedBy - collection - createdAt - createdBy required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: Agreements alias: agreements ownedBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f collection: Certificate createdAt: 1686042132022 createdBy: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get a certificate tag. tags: - Passport Tags delete: description: Removes a tag associated with a specific certificate from the system. operationId: CertificateTagController_detach parameters: - name: id required: true in: path schema: type: string description: Tag identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: 'null' required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Delete a certificate tag. tags: - Passport Tags /v1/file-store/download: get: description: >- Downloads a specific file from the file store using its unique identifier. operationId: AppController_download parameters: - name: filename required: true in: query schema: type: string description: Filename value used by this operation. example: passport.pdf responses: '200': description: Successful response. security: [] summary: Download file from file store tags: - File Store /v1/file-store/upload: post: description: >- Uploads a file to the file store and returns the file's metadata and unique identifier. operationId: AppController_upload parameters: [] requestBody: required: true content: application/octet-stream: schema: description: Upload file body type: object properties: file: format: binary description: The file to upload as form-data type: string required: - file multipart/form-data: schema: description: Upload file body type: object properties: file: format: binary description: The file to upload as form-data type: string required: - file description: Request payload for Upload file to file store responses: '200': description: Successful response. security: [] summary: Upload file to file store tags: - File Store /v1/supply-chain/catena-x: get: description: >- Authenticated Catena-X backend module boundary. Behavior is implemented by later tickets. operationId: CatenaXController_foundation parameters: [] responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Catena-X route foundation. tags: - Catena-X /v1/supply-chain/catena-x/entity-config: get: description: >- Returns safe customer-editable Catena-X configuration for the authenticated user's current entity. operationId: CatenaXController_getEntityConfig parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: enabled: type: boolean environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string participantBpn: anyOf: - type: string - type: 'null' connectorProviderType: anyOf: - anyOf: - const: self_hosted_tractus_x type: string - const: managed_edc_context type: string - const: cofinity_x_dataspace_os type: string - type: 'null' connectorDisplayName: anyOf: - type: string - type: 'null' edcManagementBaseUrl: anyOf: - type: string - type: 'null' edcProtocolBaseUrl: anyOf: - type: string - type: 'null' dtrBaseUrl: anyOf: - type: string - type: 'null' cofinityEdcComponentId: anyOf: - type: string - type: 'null' cofinityDtrComponentId: anyOf: - type: string - type: 'null' policyProfile: anyOf: - const: default_battery_pass_access type: string - type: 'null' readinessStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string missingFields: type: array items: type: string secretReadiness: type: array items: type: object properties: secretName: type: string status: anyOf: - const: missing type: string - const: present type: string - const: invalid_reference type: string - const: inaccessible type: string - const: not_checked type: string safeErrorCode: anyOf: - const: CATENA_X_FEATURE_DISABLED type: string - const: CATENA_X_MISSING_ENTITY_CONTEXT type: string - const: CATENA_X_NOT_IMPLEMENTED type: string - const: CATENA_X_ACTION_NOT_ALLOWED type: string - const: CATENA_X_MISSING_EXTERNAL_CONTRACT type: string - const: CATENA_X_SECRET_INVALID_REFERENCE type: string - const: CATENA_X_SECRET_INVALID_FORMAT type: string - const: CATENA_X_SECRET_MISSING type: string - const: CATENA_X_SECRET_INACCESSIBLE type: string - const: CATENA_X_SECRET_NOT_CHECKED type: string - const: CATENA_X_VAULT_AUTH_FAILED type: string - const: CATENA_X_VAULT_READ_FORBIDDEN type: string - const: CATENA_X_VAULT_READ_NOT_FOUND type: string - const: CATENA_X_VAULT_READ_FAILED type: string - const: CATENA_X_VAULT_NETWORK_ERROR type: string - const: CATENA_X_VAULT_CONFIG_INVALID type: string - const: CATENA_X_INVALID_PUBLICATION_TRANSITION type: string - const: CATENA_X_UNSUPPORTED_RUNTIME_ENVIRONMENT type: string - const: CATENA_X_CONNECTOR_PROVIDER_NOT_SUPPORTED type: string environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string entityId: type: string credentialStatus: anyOf: - const: denied type: string - const: missing type: string - const: unreachable type: string - const: unknown type: string credentialKind: anyOf: - const: EDC_MANAGEMENT type: string - const: DTR type: string - const: BACKEND_ORIGIN_ACCESS type: string - const: UNKNOWN type: string pathAlias: const: REDACTED_PATH_ALIAS type: string vaultStatusCode: type: number required: - secretName - status safeErrors: type: array items: type: string requiredSecrets: type: array items: type: string endpointReadiness: type: array items: {} readinessDetails: type: array items: type: object properties: category: anyOf: - const: CONNECTOR_SETUP type: string - const: IDENTITY type: string - const: CREDENTIALS type: string - const: BACKEND_OPERATIONS type: string - const: BATTERY_PASSPORT type: string key: type: string label: type: string status: anyOf: - const: ready type: string - const: missing type: string - const: present type: string - const: cannot_be_checked type: string - const: invalid_reference type: string - const: not_checked type: string - const: unsupported type: string message: type: string nextStep: type: string fixableBy: type: array items: anyOf: - const: user type: string - const: admin type: string - const: ops type: string required: - category - key - label - status - message - fixableBy publishingEntity: type: object properties: id: type: string name: type: string alias: type: string required: - id required: - enabled - environment - participantBpn - connectorProviderType - connectorDisplayName - edcManagementBaseUrl - edcProtocolBaseUrl - dtrBaseUrl - cofinityEdcComponentId - cofinityDtrComponentId - policyProfile - readinessStatus - missingFields - secretReadiness - safeErrors - publishingEntity required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: enabled: true environment: local participantBpn: participant-bpn connectorProviderType: self_hosted_tractus_x connectorDisplayName: connector-display-name edcManagementBaseUrl: https://example.com/resource edcProtocolBaseUrl: https://example.com/resource dtrBaseUrl: https://example.com/resource cofinityEdcComponentId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f cofinityDtrComponentId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f policyProfile: default_battery_pass_access readinessStatus: UNCONFIGURED missingFields: - missing-fields secretReadiness: - secretName: secret-name status: missing safeErrors: - safe-errors publishingEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get Catena-X entity configuration. tags: - Catena-X put: description: >- Accepts only customer-editable Catena-X configuration for the authenticated user's current entity. operationId: CatenaXController_upsertEntityConfig parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: type: object properties: enabled: type: boolean environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string participantBpn: anyOf: - type: string - type: 'null' connectorProviderType: anyOf: - const: self_hosted_tractus_x type: string - const: managed_edc_context type: string - const: cofinity_x_dataspace_os type: string connectorDisplayName: anyOf: - type: string - type: 'null' edcManagementBaseUrl: anyOf: - type: string - type: 'null' edcProtocolBaseUrl: anyOf: - type: string - type: 'null' dtrBaseUrl: anyOf: - type: string - type: 'null' cofinityEdcComponentId: anyOf: - type: string - type: 'null' cofinityDtrComponentId: anyOf: - type: string - type: 'null' policyProfile: const: default_battery_pass_access type: string required: - enabled - environment - connectorProviderType - policyProfile example: enabled: true environment: local participantBpn: participant-bpn connectorProviderType: self_hosted_tractus_x connectorDisplayName: connector-display-name edcManagementBaseUrl: https://example.com/resource edcProtocolBaseUrl: https://example.com/resource dtrBaseUrl: https://example.com/resource cofinityEdcComponentId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f cofinityDtrComponentId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f policyProfile: default_battery_pass_access description: Request payload for Upsert Catena-X entity configuration. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: enabled: type: boolean environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string participantBpn: anyOf: - type: string - type: 'null' connectorProviderType: anyOf: - anyOf: - const: self_hosted_tractus_x type: string - const: managed_edc_context type: string - const: cofinity_x_dataspace_os type: string - type: 'null' connectorDisplayName: anyOf: - type: string - type: 'null' edcManagementBaseUrl: anyOf: - type: string - type: 'null' edcProtocolBaseUrl: anyOf: - type: string - type: 'null' dtrBaseUrl: anyOf: - type: string - type: 'null' cofinityEdcComponentId: anyOf: - type: string - type: 'null' cofinityDtrComponentId: anyOf: - type: string - type: 'null' policyProfile: anyOf: - const: default_battery_pass_access type: string - type: 'null' readinessStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string missingFields: type: array items: type: string secretReadiness: type: array items: type: object properties: secretName: type: string status: anyOf: - const: missing type: string - const: present type: string - const: invalid_reference type: string - const: inaccessible type: string - const: not_checked type: string safeErrorCode: anyOf: - const: CATENA_X_FEATURE_DISABLED type: string - const: CATENA_X_MISSING_ENTITY_CONTEXT type: string - const: CATENA_X_NOT_IMPLEMENTED type: string - const: CATENA_X_ACTION_NOT_ALLOWED type: string - const: CATENA_X_MISSING_EXTERNAL_CONTRACT type: string - const: CATENA_X_SECRET_INVALID_REFERENCE type: string - const: CATENA_X_SECRET_INVALID_FORMAT type: string - const: CATENA_X_SECRET_MISSING type: string - const: CATENA_X_SECRET_INACCESSIBLE type: string - const: CATENA_X_SECRET_NOT_CHECKED type: string - const: CATENA_X_VAULT_AUTH_FAILED type: string - const: CATENA_X_VAULT_READ_FORBIDDEN type: string - const: CATENA_X_VAULT_READ_NOT_FOUND type: string - const: CATENA_X_VAULT_READ_FAILED type: string - const: CATENA_X_VAULT_NETWORK_ERROR type: string - const: CATENA_X_VAULT_CONFIG_INVALID type: string - const: CATENA_X_INVALID_PUBLICATION_TRANSITION type: string - const: CATENA_X_UNSUPPORTED_RUNTIME_ENVIRONMENT type: string - const: CATENA_X_CONNECTOR_PROVIDER_NOT_SUPPORTED type: string environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string entityId: type: string credentialStatus: anyOf: - const: denied type: string - const: missing type: string - const: unreachable type: string - const: unknown type: string credentialKind: anyOf: - const: EDC_MANAGEMENT type: string - const: DTR type: string - const: BACKEND_ORIGIN_ACCESS type: string - const: UNKNOWN type: string pathAlias: const: REDACTED_PATH_ALIAS type: string vaultStatusCode: type: number required: - secretName - status safeErrors: type: array items: type: string requiredSecrets: type: array items: type: string endpointReadiness: type: array items: {} readinessDetails: type: array items: type: object properties: category: anyOf: - const: CONNECTOR_SETUP type: string - const: IDENTITY type: string - const: CREDENTIALS type: string - const: BACKEND_OPERATIONS type: string - const: BATTERY_PASSPORT type: string key: type: string label: type: string status: anyOf: - const: ready type: string - const: missing type: string - const: present type: string - const: cannot_be_checked type: string - const: invalid_reference type: string - const: not_checked type: string - const: unsupported type: string message: type: string nextStep: type: string fixableBy: type: array items: anyOf: - const: user type: string - const: admin type: string - const: ops type: string required: - category - key - label - status - message - fixableBy publishingEntity: type: object properties: id: type: string name: type: string alias: type: string required: - id required: - enabled - environment - participantBpn - connectorProviderType - connectorDisplayName - edcManagementBaseUrl - edcProtocolBaseUrl - dtrBaseUrl - cofinityEdcComponentId - cofinityDtrComponentId - policyProfile - readinessStatus - missingFields - secretReadiness - safeErrors - publishingEntity required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: enabled: true environment: local participantBpn: participant-bpn connectorProviderType: self_hosted_tractus_x connectorDisplayName: connector-display-name edcManagementBaseUrl: https://example.com/resource edcProtocolBaseUrl: https://example.com/resource dtrBaseUrl: https://example.com/resource cofinityEdcComponentId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f cofinityDtrComponentId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f policyProfile: default_battery_pass_access readinessStatus: UNCONFIGURED missingFields: - missing-fields secretReadiness: - secretName: secret-name status: missing safeErrors: - safe-errors publishingEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Upsert Catena-X entity configuration. tags: - Catena-X /v1/supply-chain/catena-x/entity-config/readiness: get: description: >- Checks local configuration completeness and safe readiness without external Catena-X calls. operationId: CatenaXController_getEntityConfigReadiness parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: enabled: type: boolean environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string participantBpn: anyOf: - type: string - type: 'null' connectorProviderType: anyOf: - anyOf: - const: self_hosted_tractus_x type: string - const: managed_edc_context type: string - const: cofinity_x_dataspace_os type: string - type: 'null' connectorDisplayName: anyOf: - type: string - type: 'null' edcManagementBaseUrl: anyOf: - type: string - type: 'null' edcProtocolBaseUrl: anyOf: - type: string - type: 'null' dtrBaseUrl: anyOf: - type: string - type: 'null' cofinityEdcComponentId: anyOf: - type: string - type: 'null' cofinityDtrComponentId: anyOf: - type: string - type: 'null' policyProfile: anyOf: - const: default_battery_pass_access type: string - type: 'null' readinessStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string missingFields: type: array items: type: string secretReadiness: type: array items: type: object properties: secretName: type: string status: anyOf: - const: missing type: string - const: present type: string - const: invalid_reference type: string - const: inaccessible type: string - const: not_checked type: string safeErrorCode: anyOf: - const: CATENA_X_FEATURE_DISABLED type: string - const: CATENA_X_MISSING_ENTITY_CONTEXT type: string - const: CATENA_X_NOT_IMPLEMENTED type: string - const: CATENA_X_ACTION_NOT_ALLOWED type: string - const: CATENA_X_MISSING_EXTERNAL_CONTRACT type: string - const: CATENA_X_SECRET_INVALID_REFERENCE type: string - const: CATENA_X_SECRET_INVALID_FORMAT type: string - const: CATENA_X_SECRET_MISSING type: string - const: CATENA_X_SECRET_INACCESSIBLE type: string - const: CATENA_X_SECRET_NOT_CHECKED type: string - const: CATENA_X_VAULT_AUTH_FAILED type: string - const: CATENA_X_VAULT_READ_FORBIDDEN type: string - const: CATENA_X_VAULT_READ_NOT_FOUND type: string - const: CATENA_X_VAULT_READ_FAILED type: string - const: CATENA_X_VAULT_NETWORK_ERROR type: string - const: CATENA_X_VAULT_CONFIG_INVALID type: string - const: CATENA_X_INVALID_PUBLICATION_TRANSITION type: string - const: CATENA_X_UNSUPPORTED_RUNTIME_ENVIRONMENT type: string - const: CATENA_X_CONNECTOR_PROVIDER_NOT_SUPPORTED type: string environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string entityId: type: string credentialStatus: anyOf: - const: denied type: string - const: missing type: string - const: unreachable type: string - const: unknown type: string credentialKind: anyOf: - const: EDC_MANAGEMENT type: string - const: DTR type: string - const: BACKEND_ORIGIN_ACCESS type: string - const: UNKNOWN type: string pathAlias: const: REDACTED_PATH_ALIAS type: string vaultStatusCode: type: number required: - secretName - status safeErrors: type: array items: type: string requiredSecrets: type: array items: type: string endpointReadiness: type: array items: {} readinessDetails: type: array items: type: object properties: category: anyOf: - const: CONNECTOR_SETUP type: string - const: IDENTITY type: string - const: CREDENTIALS type: string - const: BACKEND_OPERATIONS type: string - const: BATTERY_PASSPORT type: string key: type: string label: type: string status: anyOf: - const: ready type: string - const: missing type: string - const: present type: string - const: cannot_be_checked type: string - const: invalid_reference type: string - const: not_checked type: string - const: unsupported type: string message: type: string nextStep: type: string fixableBy: type: array items: anyOf: - const: user type: string - const: admin type: string - const: ops type: string required: - category - key - label - status - message - fixableBy publishingEntity: type: object properties: id: type: string name: type: string alias: type: string required: - id required: - enabled - environment - participantBpn - connectorProviderType - connectorDisplayName - edcManagementBaseUrl - edcProtocolBaseUrl - dtrBaseUrl - cofinityEdcComponentId - cofinityDtrComponentId - policyProfile - readinessStatus - missingFields - secretReadiness - safeErrors - publishingEntity required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: enabled: true environment: local participantBpn: participant-bpn connectorProviderType: self_hosted_tractus_x connectorDisplayName: connector-display-name edcManagementBaseUrl: https://example.com/resource edcProtocolBaseUrl: https://example.com/resource dtrBaseUrl: https://example.com/resource cofinityEdcComponentId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f cofinityDtrComponentId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f policyProfile: default_battery_pass_access readinessStatus: UNCONFIGURED missingFields: - missing-fields secretReadiness: - secretName: secret-name status: missing safeErrors: - safe-errors publishingEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get Catena-X entity configuration readiness. tags: - Catena-X /v1/supply-chain/catena-x/certificates/{certificateId}/status: get: description: >- Returns backend-owned publication status, allowed actions, safe blockers, and safe audit/evidence references for the current publishing entity. operationId: CatenaXController_getCertificatePublicationStatus parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificateId: type: string publishingEntity: type: object properties: id: type: string name: type: string alias: type: string required: - id environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string entityConfigEnabled: type: boolean status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string allowedActions: type: array items: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string reason: type: string blockers: type: array items: type: string resultLink: type: string latestPublication: type: object properties: id: type: string status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string projectionHash: type: string publishedPayloadHash: type: string retryCount: type: number maxRetries: anyOf: - type: number - type: 'null' lastRetryAt: anyOf: - type: number - type: string - type: 'null' safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string updatedAt: anyOf: - type: number - type: string - type: 'null' required: - id - status latestAuditEvent: type: object properties: id: type: string actorUserId: type: string actorUserEmail: type: string publishingEntityId: type: string publishingEntityName: type: string publishingEntityBpn: type: string environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string action: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string fromStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string toStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string safeExternalArtifactRefs: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string required: - publishingEntityId - environment - toStatus externalArtifacts: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status projection: type: object properties: readinessStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string payloadHash: type: string errors: type: array items: type: object properties: path: type: string source: anyOf: - const: USER_PASSPORT_FIELD type: string - const: ENTITY_CONFIG type: string - const: VAULT_OPS type: string - const: EDC_OPS type: string - const: DERIVED type: string - const: FILE_STORAGE_RESOLVED type: string section: type: string field: type: string metadataKey: type: string fixableBy: type: array items: anyOf: - const: user type: string - const: admin type: string - const: ops type: string message: type: string reasonCode: type: string category: type: string userMessage: type: string expectedFormat: type: string nextStep: type: string actionTarget: type: object properties: type: anyOf: - const: certificate type: string - const: metadata type: string - const: section type: string - const: settings type: string - const: operations type: string key: type: string field: type: string section: type: string required: - type required: - path - source - section - field - fixableBy - message missingContracts: type: array items: type: string semanticModelUrn: const: >- urn:samm:io.catenax.battery.battery_pass:6.1.0#BatteryPass type: string specVersion: const: 6.1.0 type: string schemaHash: const: >- e1fef637937dc131c82bbf2f92ec70c6a8ccf672e1b668b4e5f48f912930ff27 type: string required: - readinessStatus - errors - missingContracts - semanticModelUrn - specVersion - schemaHash required: - certificateId - publishingEntity - environment - entityConfigEnabled - status - allowedActions required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f publishingEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f environment: local entityConfigEnabled: true status: UNCONFIGURED allowedActions: - PUBLISH '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get Catena-X publication status for a certificate. tags: - Catena-X /v1/supply-chain/catena-x/certificates/{certificateId}/readiness-preview: get: description: >- Runs backend-owned Catena-X readiness checks without creating publication records or calling external Catena-X systems. operationId: CatenaXController_getCertificateReadinessPreview parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificateId: type: string publishingEntity: type: object properties: id: type: string name: type: string alias: type: string required: - id environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string entityConfigEnabled: type: boolean status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string allowedActions: type: array items: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string reason: type: string blockers: type: array items: type: string resultLink: type: string latestPublication: type: object properties: id: type: string status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string projectionHash: type: string publishedPayloadHash: type: string retryCount: type: number maxRetries: anyOf: - type: number - type: 'null' lastRetryAt: anyOf: - type: number - type: string - type: 'null' safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string updatedAt: anyOf: - type: number - type: string - type: 'null' required: - id - status latestAuditEvent: type: object properties: id: type: string actorUserId: type: string actorUserEmail: type: string publishingEntityId: type: string publishingEntityName: type: string publishingEntityBpn: type: string environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string action: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string fromStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string toStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string safeExternalArtifactRefs: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string required: - publishingEntityId - environment - toStatus externalArtifacts: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status projection: type: object properties: readinessStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string payloadHash: type: string errors: type: array items: type: object properties: path: type: string source: anyOf: - const: USER_PASSPORT_FIELD type: string - const: ENTITY_CONFIG type: string - const: VAULT_OPS type: string - const: EDC_OPS type: string - const: DERIVED type: string - const: FILE_STORAGE_RESOLVED type: string section: type: string field: type: string metadataKey: type: string fixableBy: type: array items: anyOf: - const: user type: string - const: admin type: string - const: ops type: string message: type: string reasonCode: type: string category: type: string userMessage: type: string expectedFormat: type: string nextStep: type: string actionTarget: type: object properties: type: anyOf: - const: certificate type: string - const: metadata type: string - const: section type: string - const: settings type: string - const: operations type: string key: type: string field: type: string section: type: string required: - type required: - path - source - section - field - fixableBy - message missingContracts: type: array items: type: string semanticModelUrn: const: >- urn:samm:io.catenax.battery.battery_pass:6.1.0#BatteryPass type: string specVersion: const: 6.1.0 type: string schemaHash: const: >- e1fef637937dc131c82bbf2f92ec70c6a8ccf672e1b668b4e5f48f912930ff27 type: string required: - readinessStatus - errors - missingContracts - semanticModelUrn - specVersion - schemaHash required: - certificateId - publishingEntity - environment - entityConfigEnabled - status - allowedActions required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f publishingEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f environment: local entityConfigEnabled: true status: UNCONFIGURED allowedActions: - PUBLISH '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Preview Catena-X readiness for a Battery Passport draft. tags: - Catena-X /v1/supply-chain/catena-x/certificates/{certificateId}/evidence: get: description: >- Generates safe BatteryPass publication/configuration evidence from persisted rows without exposing sensitive material or raw external responses. operationId: CatenaXController_getCertificatePublicationEvidence parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- Auditor-safe Catena-X BatteryPass publication/configuration evidence generated on demand. required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get auditor-safe Catena-X publication evidence. tags: - Catena-X /v1/supply-chain/catena-x/certificates/{certificateId}/actions/publish: post: description: >- Validates the backend-owned allowed action state and runs Catena-X publication orchestration. operationId: CatenaXController_publishCertificate parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificateId: type: string publishingEntity: type: object properties: id: type: string name: type: string alias: type: string required: - id environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string entityConfigEnabled: type: boolean status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string allowedActions: type: array items: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string reason: type: string blockers: type: array items: type: string resultLink: type: string latestPublication: type: object properties: id: type: string status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string projectionHash: type: string publishedPayloadHash: type: string retryCount: type: number maxRetries: anyOf: - type: number - type: 'null' lastRetryAt: anyOf: - type: number - type: string - type: 'null' safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string updatedAt: anyOf: - type: number - type: string - type: 'null' required: - id - status latestAuditEvent: type: object properties: id: type: string actorUserId: type: string actorUserEmail: type: string publishingEntityId: type: string publishingEntityName: type: string publishingEntityBpn: type: string environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string action: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string fromStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string toStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string safeExternalArtifactRefs: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string required: - publishingEntityId - environment - toStatus externalArtifacts: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status projection: type: object properties: readinessStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string payloadHash: type: string errors: type: array items: type: object properties: path: type: string source: anyOf: - const: USER_PASSPORT_FIELD type: string - const: ENTITY_CONFIG type: string - const: VAULT_OPS type: string - const: EDC_OPS type: string - const: DERIVED type: string - const: FILE_STORAGE_RESOLVED type: string section: type: string field: type: string metadataKey: type: string fixableBy: type: array items: anyOf: - const: user type: string - const: admin type: string - const: ops type: string message: type: string reasonCode: type: string category: type: string userMessage: type: string expectedFormat: type: string nextStep: type: string actionTarget: type: object properties: type: anyOf: - const: certificate type: string - const: metadata type: string - const: section type: string - const: settings type: string - const: operations type: string key: type: string field: type: string section: type: string required: - type required: - path - source - section - field - fixableBy - message missingContracts: type: array items: type: string semanticModelUrn: const: >- urn:samm:io.catenax.battery.battery_pass:6.1.0#BatteryPass type: string specVersion: const: 6.1.0 type: string schemaHash: const: >- e1fef637937dc131c82bbf2f92ec70c6a8ccf672e1b668b4e5f48f912930ff27 type: string required: - readinessStatus - errors - missingContracts - semanticModelUrn - specVersion - schemaHash required: - certificateId - publishingEntity - environment - entityConfigEnabled - status - allowedActions required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f publishingEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f environment: local entityConfigEnabled: true status: UNCONFIGURED allowedActions: - PUBLISH '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Publish a BatteryPass to Catena-X. tags: - Catena-X /v1/supply-chain/catena-x/certificates/{certificateId}/actions/resync: post: description: >- Recomputes the current projection and upserts external Catena-X artifacts when allowed. operationId: CatenaXController_resyncCertificate parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificateId: type: string publishingEntity: type: object properties: id: type: string name: type: string alias: type: string required: - id environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string entityConfigEnabled: type: boolean status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string allowedActions: type: array items: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string reason: type: string blockers: type: array items: type: string resultLink: type: string latestPublication: type: object properties: id: type: string status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string projectionHash: type: string publishedPayloadHash: type: string retryCount: type: number maxRetries: anyOf: - type: number - type: 'null' lastRetryAt: anyOf: - type: number - type: string - type: 'null' safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string updatedAt: anyOf: - type: number - type: string - type: 'null' required: - id - status latestAuditEvent: type: object properties: id: type: string actorUserId: type: string actorUserEmail: type: string publishingEntityId: type: string publishingEntityName: type: string publishingEntityBpn: type: string environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string action: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string fromStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string toStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string safeExternalArtifactRefs: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string required: - publishingEntityId - environment - toStatus externalArtifacts: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status projection: type: object properties: readinessStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string payloadHash: type: string errors: type: array items: type: object properties: path: type: string source: anyOf: - const: USER_PASSPORT_FIELD type: string - const: ENTITY_CONFIG type: string - const: VAULT_OPS type: string - const: EDC_OPS type: string - const: DERIVED type: string - const: FILE_STORAGE_RESOLVED type: string section: type: string field: type: string metadataKey: type: string fixableBy: type: array items: anyOf: - const: user type: string - const: admin type: string - const: ops type: string message: type: string reasonCode: type: string category: type: string userMessage: type: string expectedFormat: type: string nextStep: type: string actionTarget: type: object properties: type: anyOf: - const: certificate type: string - const: metadata type: string - const: section type: string - const: settings type: string - const: operations type: string key: type: string field: type: string section: type: string required: - type required: - path - source - section - field - fixableBy - message missingContracts: type: array items: type: string semanticModelUrn: const: >- urn:samm:io.catenax.battery.battery_pass:6.1.0#BatteryPass type: string specVersion: const: 6.1.0 type: string schemaHash: const: >- e1fef637937dc131c82bbf2f92ec70c6a8ccf672e1b668b4e5f48f912930ff27 type: string required: - readinessStatus - errors - missingContracts - semanticModelUrn - specVersion - schemaHash required: - certificateId - publishingEntity - environment - entityConfigEnabled - status - allowedActions required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f publishingEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f environment: local entityConfigEnabled: true status: UNCONFIGURED allowedActions: - PUBLISH '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Resync a Catena-X BatteryPass publication. tags: - Catena-X /v1/supply-chain/catena-x/certificates/{certificateId}/actions/retry: post: description: Re-enters the queued publication flow only from RETRYABLE_FAILED. operationId: CatenaXController_retryCertificate parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificateId: type: string publishingEntity: type: object properties: id: type: string name: type: string alias: type: string required: - id environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string entityConfigEnabled: type: boolean status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string allowedActions: type: array items: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string reason: type: string blockers: type: array items: type: string resultLink: type: string latestPublication: type: object properties: id: type: string status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string projectionHash: type: string publishedPayloadHash: type: string retryCount: type: number maxRetries: anyOf: - type: number - type: 'null' lastRetryAt: anyOf: - type: number - type: string - type: 'null' safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string updatedAt: anyOf: - type: number - type: string - type: 'null' required: - id - status latestAuditEvent: type: object properties: id: type: string actorUserId: type: string actorUserEmail: type: string publishingEntityId: type: string publishingEntityName: type: string publishingEntityBpn: type: string environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string action: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string fromStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string toStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string safeExternalArtifactRefs: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string required: - publishingEntityId - environment - toStatus externalArtifacts: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status projection: type: object properties: readinessStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string payloadHash: type: string errors: type: array items: type: object properties: path: type: string source: anyOf: - const: USER_PASSPORT_FIELD type: string - const: ENTITY_CONFIG type: string - const: VAULT_OPS type: string - const: EDC_OPS type: string - const: DERIVED type: string - const: FILE_STORAGE_RESOLVED type: string section: type: string field: type: string metadataKey: type: string fixableBy: type: array items: anyOf: - const: user type: string - const: admin type: string - const: ops type: string message: type: string reasonCode: type: string category: type: string userMessage: type: string expectedFormat: type: string nextStep: type: string actionTarget: type: object properties: type: anyOf: - const: certificate type: string - const: metadata type: string - const: section type: string - const: settings type: string - const: operations type: string key: type: string field: type: string section: type: string required: - type required: - path - source - section - field - fixableBy - message missingContracts: type: array items: type: string semanticModelUrn: const: >- urn:samm:io.catenax.battery.battery_pass:6.1.0#BatteryPass type: string specVersion: const: 6.1.0 type: string schemaHash: const: >- e1fef637937dc131c82bbf2f92ec70c6a8ccf672e1b668b4e5f48f912930ff27 type: string required: - readinessStatus - errors - missingContracts - semanticModelUrn - specVersion - schemaHash required: - certificateId - publishingEntity - environment - entityConfigEnabled - status - allowedActions required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f publishingEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f environment: local entityConfigEnabled: true status: UNCONFIGURED allowedActions: - PUBLISH '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retry a retryable Catena-X BatteryPass publication failure. tags: - Catena-X /v1/supply-chain/catena-x/certificates/{certificateId}/actions/unpublish: post: description: >- Validates action state. External unpublish is fail-closed until adapter delete contracts exist. operationId: CatenaXController_unpublishCertificate parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificateId: type: string publishingEntity: type: object properties: id: type: string name: type: string alias: type: string required: - id environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string entityConfigEnabled: type: boolean status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string allowedActions: type: array items: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string reason: type: string blockers: type: array items: type: string resultLink: type: string latestPublication: type: object properties: id: type: string status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string projectionHash: type: string publishedPayloadHash: type: string retryCount: type: number maxRetries: anyOf: - type: number - type: 'null' lastRetryAt: anyOf: - type: number - type: string - type: 'null' safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string updatedAt: anyOf: - type: number - type: string - type: 'null' required: - id - status latestAuditEvent: type: object properties: id: type: string actorUserId: type: string actorUserEmail: type: string publishingEntityId: type: string publishingEntityName: type: string publishingEntityBpn: type: string environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string action: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string fromStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string toStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string safeExternalArtifactRefs: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string required: - publishingEntityId - environment - toStatus externalArtifacts: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status projection: type: object properties: readinessStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string payloadHash: type: string errors: type: array items: type: object properties: path: type: string source: anyOf: - const: USER_PASSPORT_FIELD type: string - const: ENTITY_CONFIG type: string - const: VAULT_OPS type: string - const: EDC_OPS type: string - const: DERIVED type: string - const: FILE_STORAGE_RESOLVED type: string section: type: string field: type: string metadataKey: type: string fixableBy: type: array items: anyOf: - const: user type: string - const: admin type: string - const: ops type: string message: type: string reasonCode: type: string category: type: string userMessage: type: string expectedFormat: type: string nextStep: type: string actionTarget: type: object properties: type: anyOf: - const: certificate type: string - const: metadata type: string - const: section type: string - const: settings type: string - const: operations type: string key: type: string field: type: string section: type: string required: - type required: - path - source - section - field - fixableBy - message missingContracts: type: array items: type: string semanticModelUrn: const: >- urn:samm:io.catenax.battery.battery_pass:6.1.0#BatteryPass type: string specVersion: const: 6.1.0 type: string schemaHash: const: >- e1fef637937dc131c82bbf2f92ec70c6a8ccf672e1b668b4e5f48f912930ff27 type: string required: - readinessStatus - errors - missingContracts - semanticModelUrn - specVersion - schemaHash required: - certificateId - publishingEntity - environment - entityConfigEnabled - status - allowedActions required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f publishingEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f environment: local entityConfigEnabled: true status: UNCONFIGURED allowedActions: - PUBLISH '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Unpublish a Catena-X BatteryPass publication. tags: - Catena-X /v1/supply-chain/catena-x/certificates/{certificateId}/actions/revoke: post: description: >- Validates action state. External revoke is fail-closed until adapter revoke contracts exist. operationId: CatenaXController_revokeCertificate parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificateId: type: string publishingEntity: type: object properties: id: type: string name: type: string alias: type: string required: - id environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string entityConfigEnabled: type: boolean status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string allowedActions: type: array items: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string reason: type: string blockers: type: array items: type: string resultLink: type: string latestPublication: type: object properties: id: type: string status: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string projectionHash: type: string publishedPayloadHash: type: string retryCount: type: number maxRetries: anyOf: - type: number - type: 'null' lastRetryAt: anyOf: - type: number - type: string - type: 'null' safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string updatedAt: anyOf: - type: number - type: string - type: 'null' required: - id - status latestAuditEvent: type: object properties: id: type: string actorUserId: type: string actorUserEmail: type: string publishingEntityId: type: string publishingEntityName: type: string publishingEntityBpn: type: string environment: anyOf: - const: local type: string - const: test type: string - const: staging type: string - const: production type: string action: anyOf: - const: PUBLISH type: string - const: RESYNC type: string - const: UNPUBLISH type: string - const: REVOKE type: string - const: RETRY type: string - const: OPEN_RESULT type: string - const: COPY_LINK type: string fromStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string toStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string safeExternalArtifactRefs: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status safeErrorCode: type: string safeErrorDetails: {} createdAt: anyOf: - type: number - type: string required: - publishingEntityId - environment - toStatus externalArtifacts: type: array items: type: object properties: id: type: string kind: anyOf: - const: DTR_SHELL type: string - const: DTR_SUBMODEL_DESCRIPTOR type: string - const: DISCOVERY_RECORD type: string - const: EDC_ASSET type: string - const: EDC_POLICY type: string - const: EDC_ACCESS_POLICY type: string - const: EDC_USAGE_POLICY type: string - const: EDC_CONTRACT_DEFINITION type: string externalId: type: string href: type: string status: type: string safeMetadata: {} createdAt: anyOf: - type: number - type: string required: - kind - externalId - status projection: type: object properties: readinessStatus: anyOf: - const: UNCONFIGURED type: string - const: NOT_ELIGIBLE type: string - const: READY type: string - const: VALIDATION_FAILED type: string - const: QUEUED type: string - const: PUBLISHING type: string - const: PUBLISHED type: string - const: OUT_OF_SYNC type: string - const: RETRYABLE_FAILED type: string - const: TERMINAL_FAILED type: string - const: UNPUBLISHING type: string - const: UNPUBLISHED type: string - const: REVOKING type: string - const: REVOKED type: string payloadHash: type: string errors: type: array items: type: object properties: path: type: string source: anyOf: - const: USER_PASSPORT_FIELD type: string - const: ENTITY_CONFIG type: string - const: VAULT_OPS type: string - const: EDC_OPS type: string - const: DERIVED type: string - const: FILE_STORAGE_RESOLVED type: string section: type: string field: type: string metadataKey: type: string fixableBy: type: array items: anyOf: - const: user type: string - const: admin type: string - const: ops type: string message: type: string reasonCode: type: string category: type: string userMessage: type: string expectedFormat: type: string nextStep: type: string actionTarget: type: object properties: type: anyOf: - const: certificate type: string - const: metadata type: string - const: section type: string - const: settings type: string - const: operations type: string key: type: string field: type: string section: type: string required: - type required: - path - source - section - field - fixableBy - message missingContracts: type: array items: type: string semanticModelUrn: const: >- urn:samm:io.catenax.battery.battery_pass:6.1.0#BatteryPass type: string specVersion: const: 6.1.0 type: string schemaHash: const: >- e1fef637937dc131c82bbf2f92ec70c6a8ccf672e1b668b4e5f48f912930ff27 type: string required: - readinessStatus - errors - missingContracts - semanticModelUrn - specVersion - schemaHash required: - certificateId - publishingEntity - environment - entityConfigEnabled - status - allowedActions required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f publishingEntity: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f environment: local entityConfigEnabled: true status: UNCONFIGURED allowedActions: - PUBLISH '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Revoke a Catena-X BatteryPass publication. tags: - Catena-X /v1/supply-chain/catena-x/certificates/{certificateId}/submodel/battery-pass: get: description: >- Returns the BatteryPass 6.1.0 payload for either the authenticated current entity or configured EDC data-plane machine access. operationId: CatenaXDataPlaneController_getBatteryPassSubmodel parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: entityId required: true in: query schema: type: string description: Entity id value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: publicationId required: true in: query schema: type: string description: Publication id value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- BatteryPass 6.1.0 payload when readiness is READY, or Catena-X projection validation status without payloadCandidate when validation fails. required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get Catena-X BatteryPass submodel payload. tags: - Catena-X /v1/supply-chain/passport-attention/dashboard: get: description: >- Returns an owner-scoped dashboard preview ordered by attention priority. Only current passports owned by the caller's entity are included. operationId: PassportAttentionController_dashboard parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: items: type: array items: type: object properties: certificate: type: object properties: id: type: string rootId: type: string code: type: string type: type: string status: type: string version: type: integer labels: type: array items: type: object properties: id: type: string name: type: string required: - id - name required: - id - rootId - code - type - status - version - labels completeness: type: object properties: mandatory: type: object properties: completed: anyOf: - type: integer - type: 'null' total: anyOf: - type: integer - type: 'null' percentage: anyOf: - type: number - type: 'null' applicable: type: boolean required: - completed - total - percentage - applicable optional: type: object properties: completed: anyOf: - type: integer - type: 'null' total: anyOf: - type: integer - type: 'null' percentage: anyOf: - type: number - type: 'null' applicable: type: boolean required: - completed - total - percentage - applicable full: type: object properties: completed: anyOf: - type: integer - type: 'null' total: anyOf: - type: integer - type: 'null' percentage: anyOf: - type: number - type: 'null' applicable: type: boolean required: - completed - total - percentage - applicable required: - mandatory - optional - full issues: type: array items: type: object properties: id: type: string source: type: string issueKey: type: string sectionKey: anyOf: - type: string - type: 'null' activeSince: type: number details: {} required: - id - source - issueKey - sectionKey - activeSince - details required: - certificate - completeness - issues totalPassports: type: integer required: - items - totalPassports required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: items: - certificate: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f rootId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f code: ABC123 type: product-passport status: published version: 0 labels: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name completeness: mandatory: completed: 0 total: 0 percentage: 0 applicable: true optional: completed: 0 total: 0 percentage: 0 applicable: true full: completed: 0 total: 0 percentage: 0 applicable: true issues: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f source: source issueKey: metadata.key sectionKey: metadata.key activeSince: 0 details: details totalPassports: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get the five highest-priority current passports requiring attention. tags: - Passport Attention /v1/supply-chain/passport-attention/insights: get: description: >- Returns completeness totals and issue breakdowns for current passports owned by the caller's entity and matching the supplied filters. operationId: PassportAttentionController_insights parameters: - name: type required: false in: query schema: anyOf: - type: string - type: array items: anyOf: - const: product-passport type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: status required: false in: query schema: anyOf: - type: string - type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string description: Filter by lifecycle status. example: published - name: source required: false in: query schema: anyOf: - type: string - type: array items: anyOf: - const: mandatory_incomplete type: string - const: optional_incomplete type: string - const: dynamic_stale type: string - const: material_overuse type: string description: Source value used by this operation. example: source - name: label required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: startTimestamp required: false in: query schema: pattern: ^[0-9]{10}$ type: string description: Inclusive start of the requested time range in epoch milliseconds. example: '1767225600' - name: endTimestamp required: false in: query schema: pattern: ^[0-9]{10}$ type: string description: Inclusive end of the requested time range in epoch milliseconds. example: '1767225600' responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: generatedAt: type: number population: type: object properties: currentPassports: type: integer currentContextReady: type: integer outdatedWithPreviousResult: type: integer updatingWithPreviousResult: type: integer pendingWithoutResult: type: integer failedWithPreviousResult: type: integer failedWithoutResult: type: integer notApplicable: type: integer required: - currentPassports - currentContextReady - outdatedWithPreviousResult - updatingWithPreviousResult - pendingWithoutResult - failedWithPreviousResult - failedWithoutResult - notApplicable completeness: type: object properties: mandatory: type: object properties: completed: type: integer total: type: integer percentage: anyOf: - type: number - type: 'null' applicable: type: boolean completePassports: type: integer applicablePassports: type: integer passportCompletionRate: anyOf: - type: number - type: 'null' required: - completed - total - percentage - applicable - completePassports - applicablePassports - passportCompletionRate optional: type: object properties: completed: type: integer total: type: integer percentage: anyOf: - type: number - type: 'null' applicable: type: boolean completePassports: type: integer applicablePassports: type: integer passportCompletionRate: anyOf: - type: number - type: 'null' required: - completed - total - percentage - applicable - completePassports - applicablePassports - passportCompletionRate full: type: object properties: completed: type: integer total: type: integer percentage: anyOf: - type: number - type: 'null' applicable: type: boolean completePassports: type: integer applicablePassports: type: integer passportCompletionRate: anyOf: - type: number - type: 'null' required: - completed - total - percentage - applicable - completePassports - applicablePassports - passportCompletionRate required: - mandatory - optional - full attention: type: object properties: passportsRequiringAttention: type: integer activeIssueCount: type: integer bySource: type: array items: type: object properties: source: type: string passportCount: type: integer issueCount: type: integer required: - source - passportCount - issueCount bySection: type: array items: type: object properties: sectionKey: type: string title: type: object properties: i18nId: type: string fallback: type: string required: - fallback passportCount: type: integer issueCount: type: integer required: - sectionKey - title - passportCount - issueCount required: - passportsRequiringAttention - activeIssueCount - bySource - bySection required: - generatedAt - population - completeness - attention required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: generatedAt: 0 population: currentPassports: 0 currentContextReady: 0 outdatedWithPreviousResult: 0 updatingWithPreviousResult: 0 pendingWithoutResult: 0 failedWithPreviousResult: 0 failedWithoutResult: 0 notApplicable: 0 completeness: mandatory: completed: 0 total: 0 percentage: 0 applicable: true completePassports: 0 applicablePassports: 0 passportCompletionRate: 0 optional: completed: 0 total: 0 percentage: 0 applicable: true completePassports: 0 applicablePassports: 0 passportCompletionRate: 0 full: completed: 0 total: 0 percentage: 0 applicable: true completePassports: 0 applicablePassports: 0 passportCompletionRate: 0 attention: passportsRequiringAttention: 0 activeIssueCount: 0 bySource: - source: source passportCount: 0 issueCount: 0 bySection: - sectionKey: metadata.key title: fallback: fallback passportCount: 0 issueCount: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get owner-scoped current passport completeness insights. tags: - Passport Attention /v1/supply-chain/passport-attention/recalculations: post: description: >- Queues completeness recalculation for all current passports of the requested type owned by the caller's entity and returns the queued count. operationId: PassportAttentionController_createRecalculation parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: queued: minimum: 0 type: integer jobs: type: array items: type: object properties: jobId: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string queue: type: string required: - jobId - queue required: - queued required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: queued: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Recalculate every current owned passport of one type. tags: - Passport Attention /v1/supply-chain/passport-attention/exports: post: description: >- Queues a private export using the supplied passport filters and returns an export ID that can be polled until completion. operationId: PassportAttentionController_createExport parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string queue: type: string status: const: pending type: string format: anyOf: - const: csv type: string - const: pdf type: string - const: html type: string createdAt: type: number required: - id - status - format - createdAt required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: pending format: csv createdAt: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Create an asynchronous passport completeness export. tags: - Passport Attention /v1/supply-chain/passport-attention/exports/{exportId}: get: description: >- Returns the current state and progress of an export owned by the caller's entity. Export ownership is enforced. operationId: PassportAttentionController_exportStatus parameters: - name: exportId required: true in: path schema: type: string description: Export identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string format: anyOf: - const: csv type: string - const: pdf type: string - const: html type: string status: anyOf: - const: pending type: string - const: running type: string - const: completed type: string - const: failed type: string - const: expired type: string progress: type: integer processedRows: type: integer totalRows: anyOf: - type: integer - type: 'null' filters: additionalProperties: false type: object properties: type: uniqueItems: true type: array items: anyOf: - const: product-passport type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string status: uniqueItems: true type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string source: uniqueItems: true type: array items: anyOf: - const: mandatory_incomplete type: string - const: optional_incomplete type: string - const: dynamic_stale type: string - const: material_overuse type: string label: anyOf: - example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string - type: 'null' startTimestamp: anyOf: - minimum: 0 maximum: 9999999999 type: integer - type: 'null' endTimestamp: anyOf: - minimum: 0 maximum: 9999999999 type: integer - type: 'null' scope: not: {} top: anyOf: - const: 10 type: number - type: 'null' createdAt: type: number startedAt: anyOf: - type: number - type: 'null' snapshotAt: anyOf: - type: number - type: 'null' completedAt: anyOf: - type: number - type: 'null' expiresAt: anyOf: - type: number - type: 'null' artifactReady: type: boolean artifactSize: anyOf: - type: number - type: 'null' artifactKind: anyOf: - const: csv type: string - const: report_bundle type: string - type: 'null' lastErrorCode: type: string required: - id - format - status - progress - processedRows - totalRows - filters - top - createdAt - startedAt - snapshotAt - completedAt - expiresAt - artifactReady - artifactSize - artifactKind required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f format: csv status: pending progress: 0 processedRows: 0 totalRows: 0 filters: {} top: 10 createdAt: 0 startedAt: 0 snapshotAt: 0 completedAt: 0 expiresAt: 0 artifactReady: true artifactSize: 0 artifactKind: csv '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Read the status of an owned passport completeness export. tags: - Passport Attention /v1/supply-chain/passport-attention/exports/{exportId}/download: get: description: >- Returns download metadata for a completed export owned by the caller's entity; incomplete or foreign exports are rejected. operationId: PassportAttentionController_downloadExport parameters: - name: exportId required: true in: path schema: type: string description: Export identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: url: type: string filename: type: string mime: type: string size: type: number required: - url - filename - mime - size required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: url: https://example.com/resource filename: passport.pdf mime: mime size: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Authorize access to a completed private passport completeness export. tags: - Passport Attention /v1/supply-chain/passport-attention/exports/{exportId}/artifact: get: description: >- Streams the generated CSV or JSON artifact after verifying entity ownership and successful export completion. operationId: PassportAttentionController_streamExport parameters: - name: exportId required: true in: path schema: type: string description: Export identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Generated export artifact. content: text/csv: schema: type: string format: binary application/json: schema: type: string format: binary '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Stream an owned completed passport completeness export. tags: - Passport Attention /v1/supply-chain/passport-attention/certificates/{certificateId}: get: description: >- Returns calculated completeness, sections, and attention issues for one current passport owned by the caller's entity. operationId: PassportAttentionController_detail parameters: - name: certificateId required: true in: path schema: type: string description: Certificate identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: certificate: type: object properties: id: type: string rootId: type: string code: type: string type: type: string status: type: string version: type: integer labels: type: array items: type: object properties: id: type: string name: type: string required: - id - name required: - id - rootId - code - type - status - version - labels completeness: type: object properties: mandatory: type: object properties: completed: anyOf: - type: integer - type: 'null' total: anyOf: - type: integer - type: 'null' percentage: anyOf: - type: number - type: 'null' applicable: type: boolean required: - completed - total - percentage - applicable optional: type: object properties: completed: anyOf: - type: integer - type: 'null' total: anyOf: - type: integer - type: 'null' percentage: anyOf: - type: number - type: 'null' applicable: type: boolean required: - completed - total - percentage - applicable full: type: object properties: completed: anyOf: - type: integer - type: 'null' total: anyOf: - type: integer - type: 'null' percentage: anyOf: - type: number - type: 'null' applicable: type: boolean required: - completed - total - percentage - applicable required: - mandatory - optional - full sections: type: array items: {} issues: type: array items: type: object properties: id: type: string source: type: string issueKey: type: string sectionKey: anyOf: - type: string - type: 'null' activeSince: type: number details: {} required: - id - source - issueKey - sectionKey - activeSince - details calculation: type: object properties: status: type: string calculatedAt: anyOf: - type: number - type: 'null' outdated: type: boolean required: - status - calculatedAt - outdated required: - certificate - completeness - sections - issues - calculation required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: certificate: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f rootId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f code: ABC123 type: product-passport status: published version: 0 labels: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name completeness: mandatory: completed: 0 total: 0 percentage: 0 applicable: true optional: completed: 0 total: 0 percentage: 0 applicable: true full: completed: 0 total: 0 percentage: 0 applicable: true sections: - sections issues: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f source: source issueKey: metadata.key sectionKey: metadata.key activeSince: 0 details: details calculation: status: published calculatedAt: 0 outdated: true '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: >- Get the internal completeness and attention detail for one owned passport. tags: - Passport Attention /v1/supply-chain/passport-attention: get: description: >- Returns a paginated list and summary for current passports owned by the caller's entity, ordered and filtered by attention criteria. operationId: PassportAttentionController_list parameters: - name: type required: false in: query schema: anyOf: - type: string - type: array items: anyOf: - const: product-passport type: string - const: battery-passport type: string - const: pv-passport type: string - const: simplified-pv-passport type: string - const: batch-passport type: string - const: material-passport type: string - const: tyre-passport type: string description: Type value used by this operation. example: product-passport - name: status required: false in: query schema: anyOf: - type: string - type: array items: anyOf: - const: draft type: string - const: ready type: string - const: published type: string description: Filter by lifecycle status. example: published - name: source required: false in: query schema: anyOf: - type: string - type: array items: anyOf: - const: mandatory_incomplete type: string - const: optional_incomplete type: string - const: dynamic_stale type: string - const: material_overuse type: string description: Source value used by this operation. example: source - name: label required: false in: query schema: example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f maxLength: 36 minLength: 36 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Label value used by this operation. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: startTimestamp required: false in: query schema: pattern: ^[0-9]{10}$ type: string description: Inclusive start of the requested time range in epoch milliseconds. example: '1767225600' - name: endTimestamp required: false in: query schema: pattern: ^[0-9]{10}$ type: string description: Inclusive end of the requested time range in epoch milliseconds. example: '1767225600' - name: order required: false in: query schema: anyOf: - const: priority type: string - const: mandatory_asc type: string - const: oldest type: string description: Result ordering expression. example: priority responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: summary: type: object properties: totalPassports: type: integer required: - totalPassports items: type: array items: type: object properties: certificate: type: object properties: id: type: string rootId: type: string code: type: string type: type: string status: type: string version: type: integer labels: type: array items: type: object properties: id: type: string name: type: string required: - id - name required: - id - rootId - code - type - status - version - labels completeness: type: object properties: mandatory: type: object properties: completed: anyOf: - type: integer - type: 'null' total: anyOf: - type: integer - type: 'null' percentage: anyOf: - type: number - type: 'null' applicable: type: boolean required: - completed - total - percentage - applicable optional: type: object properties: completed: anyOf: - type: integer - type: 'null' total: anyOf: - type: integer - type: 'null' percentage: anyOf: - type: number - type: 'null' applicable: type: boolean required: - completed - total - percentage - applicable full: type: object properties: completed: anyOf: - type: integer - type: 'null' total: anyOf: - type: integer - type: 'null' percentage: anyOf: - type: number - type: 'null' applicable: type: boolean required: - completed - total - percentage - applicable required: - mandatory - optional - full sections: type: array items: {} issues: type: array items: type: object properties: id: type: string source: type: string issueKey: type: string sectionKey: anyOf: - type: string - type: 'null' activeSince: type: number details: {} required: - id - source - issueKey - sectionKey - activeSince - details required: - certificate - completeness - sections - issues required: - summary - items required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: summary: totalPassports: 0 items: - certificate: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f rootId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f code: ABC123 type: product-passport status: published version: 0 labels: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name completeness: mandatory: completed: 0 total: 0 percentage: 0 applicable: true optional: completed: 0 total: 0 percentage: 0 applicable: true full: completed: 0 total: 0 percentage: 0 applicable: true sections: - sections issues: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f source: source issueKey: metadata.key sectionKey: metadata.key activeSince: 0 details: details '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get the filtered, owner-scoped Requires Attention passport list. tags: - Passport Attention /v1/supply-chain/certificates/{certificateId}/dpp-package/exports: post: description: >- Queues a portable ZIP export for the exact published or deprecated Battery Passport version. The export is generated and validated before it becomes downloadable, so API errors are never returned as a downloaded package. operationId: createCertificateDppPackageExport parameters: - name: certificateId required: true in: path description: Exact Minespider certificate UUID to export. schema: type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: format: uuid example: b8f17d77-28ab-4ce9-a5ee-6e7543cdde27 type: string status: const: pending type: string createdAt: example: 1790169600000 type: number required: - id - status - createdAt required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: id: b8f17d77-28ab-4ce9-a5ee-6e7543cdde27 status: pending createdAt: 1790169600000 '400': description: The certificate is not a published or deprecated Battery Passport. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 400 success: false content: null messages: - >- Only published or deprecated Battery Passports can be exported. '401': description: Authentication is required. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: success: false statusCode: 422 errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT content: null messages: - messages '404': description: The certificate does not exist or is not readable by the caller. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: success: false statusCode: 422 errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT content: null messages: - messages '429': description: >- The caller has exceeded the DPP export limit of five requests per minute. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 429 success: false content: null messages: - 'ThrottlerException: Too Many Requests' '503': description: The export could not be queued. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 503 success: false content: null messages: - DPP package export could not be queued. security: - bearer: [] - cookie: [] summary: Create a private DPP package export. tags: - Product Passports /v1/supply-chain/certificates/{certificateId}/dpp-package/exports/{exportId}: get: description: >- Returns the state of an export owned by the authenticated caller's entity for this certificate. operationId: getCertificateDppPackageExportStatus parameters: - name: exportId required: true in: path description: DPP package export UUID. schema: type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path description: Exact Minespider certificate UUID. schema: type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: format: uuid example: b8f17d77-28ab-4ce9-a5ee-6e7543cdde27 type: string status: anyOf: - const: pending type: string - const: running type: string - const: completed type: string - const: failed type: string - const: expired type: string createdAt: example: 1790169600000 type: number startedAt: anyOf: - type: number - type: 'null' completedAt: anyOf: - type: number - type: 'null' expiresAt: anyOf: - type: number - type: 'null' artifactReady: type: boolean artifactSize: anyOf: - type: number - type: 'null' lastErrorCode: example: DPP_PACKAGE_EXPORT_PROCESSING_FAILED type: string required: - id - status - createdAt - startedAt - completedAt - expiresAt - artifactReady - artifactSize required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: b8f17d77-28ab-4ce9-a5ee-6e7543cdde27 status: pending createdAt: 1790169600000 startedAt: 0 completedAt: 0 expiresAt: 0 artifactReady: true artifactSize: 0 '401': description: Authentication is required. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: success: false statusCode: 422 errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT content: null messages: - messages '404': description: >- The certificate or export does not exist or is not readable by the caller. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: success: false statusCode: 422 errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT content: null messages: - messages '503': description: The completed export result is unavailable. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 503 success: false content: null messages: - DPP package export result is unavailable. security: - bearer: [] - cookie: [] summary: Read the status of a private DPP package export. tags: - Product Passports /v1/supply-chain/certificates/{certificateId}/dpp-package/exports/{exportId}/download: get: description: >- Returns download metadata only after the package has been generated and validated successfully and the caller still has access to every included visibility layer. operationId: getCertificateDppPackageExportDownload parameters: - name: exportId required: true in: path description: DPP package export UUID. schema: type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path description: Exact Minespider certificate UUID. schema: type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: url: example: >- /api/v1/supply-chain/certificates/6f807d3a-3d22-4b84-bf1a-12d6dc41585a/dpp-package/exports/b8f17d77-28ab-4ce9-a5ee-6e7543cdde27/artifact type: string filename: example: BATTERY-001-dpp.zip type: string mime: const: application/zip type: string size: example: 184320 type: number required: - url - filename - mime - size required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: url: >- /api/v1/supply-chain/certificates/6f807d3a-3d22-4b84-bf1a-12d6dc41585a/dpp-package/exports/b8f17d77-28ab-4ce9-a5ee-6e7543cdde27/artifact filename: BATTERY-001-dpp.zip mime: application/zip size: 184320 '401': description: Authentication is required. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: success: false statusCode: 422 errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT content: null messages: - messages '403': description: >- Access to a visibility layer included in the export has expired or been revoked. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 403 success: false content: null messages: - Access to the DPP package export has changed. '404': description: >- The certificate or export does not exist or is not readable by the caller. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: success: false statusCode: 422 errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT content: null messages: - messages '409': description: The export failed or its artifact is not ready. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 409 success: false content: null messages: - DPP package export artifact is not ready. '410': description: The export artifact has expired. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 410 success: false content: null messages: - DPP package export artifact has expired. '503': description: The completed export artifact is unavailable. content: application/json: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 503 success: false content: null messages: - DPP package export artifact is unavailable. security: - bearer: [] - cookie: [] summary: Authorize a completed private DPP package download. tags: - Product Passports /v1/supply-chain/certificates/{certificateId}/dpp-package/exports/{exportId}/artifact: get: description: >- Streams a validated ZIP artifact after rechecking export ownership and access to every included visibility layer. operationId: downloadCertificateDppPackageExportArtifact parameters: - name: exportId required: true in: path description: DPP package export UUID. schema: type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: certificateId required: true in: path description: Exact Minespider certificate UUID. schema: type: string example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Validated portable DPP ZIP package. content: application/zip: schema: format: binary description: >- Portable DPP ZIP package containing manifest.json, dpp.json, relations.json, events.json, README.md, and visible resources. type: string '401': description: Authentication is required. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: success: false statusCode: 422 errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT content: null messages: - messages '403': description: >- Access to a visibility layer included in the export has expired or been revoked. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 403 success: false content: null messages: - Access to the DPP package export has changed. '404': description: >- The certificate or export does not exist or is not readable by the caller. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: success: false statusCode: 422 errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT content: null messages: - messages '409': description: The export failed or its artifact is not ready. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 409 success: false content: null messages: - DPP package export artifact is not ready. '410': description: The export artifact has expired. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 410 success: false content: null messages: - DPP package export artifact has expired. '503': description: The completed export artifact is unavailable. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 503 success: false content: null messages: - DPP package export artifact is unavailable. security: - bearer: [] - cookie: [] summary: Download a completed private DPP package export. tags: - Product Passports /v1/supply-chain/certificates/{certificateId}/dpp-package: get: description: >- Exports the exact published or deprecated Battery Passport version identified by id as a portable ZIP package. The package contains only data and files visible to the authenticated caller. Incomplete BatteryPass data is exported as-is and reported through machine-readable manifest warnings; package integrity and resource checks remain strict. The manifest includes Minespider export provenance and available completeness metrics. If dynamic data is temporarily unavailable, the package uses the persisted metadata snapshot and records that fallback in the Minespider export extension. Visible source metadata that is outside the BatteryPass profile is preserved in a namespaced dpp.json extension. Linked published or deprecated Battery Passports use their public DPP identifiers when available. operationId: exportCertificateDppPackage parameters: - name: certificateId required: true in: path description: >- Exact Minespider certificate UUID to export. Deprecated IDs are not replaced by the latest version. schema: example: 6f807d3a-3d22-4b84-bf1a-12d6dc41585a type: string example: 6f807d3a-3d22-4b84-bf1a-12d6dc41585a responses: '200': description: >- Portable DPP ZIP package containing manifest.json, dpp.json, relations.json, events.json, README.md, and visible resources. manifest.partial only indicates omitted resource bytes; form completeness is reported separately in manifest.extensions.com.minespider.export.completeness. content: application/zip: schema: format: binary description: >- Portable DPP ZIP package containing manifest.json, dpp.json, relations.json, events.json, README.md, and visible resources. type: string '400': description: >- The certificate is not a Battery Passport or is not published/deprecated. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 400 success: false content: null messages: - >- Only published or deprecated Battery Passports can be exported. '401': description: Authentication is required. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: success: false statusCode: 422 errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT content: null messages: - messages '404': description: The certificate does not exist or is not readable by the caller. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: success: false statusCode: 422 errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT content: null messages: - messages '422': description: >- The visible data cannot satisfy the structural portable-package contract. Missing or invalid BatteryPass profile fields remain downloadable and are returned as advisory manifest warnings. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: DPP_PACKAGE_EXPORT_INVALID_INPUT statusCode: 422 success: false content: null messages: - >- Quantity must be a number (relations.json#/relations/0/quantity/value) '429': description: >- The caller has exceeded the DPP export limit of five requests per minute. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 429 success: false content: null messages: - 'ThrottlerException: Too Many Requests' '503': description: One or more packaged files are temporarily unavailable. content: application/zip: schema: additionalProperties: false type: object properties: _meta: additionalProperties: false type: object properties: success: example: false const: false type: boolean statusCode: description: HTTP response status. example: 422 type: integer errorCode: description: >- Stable application error code, or 0 for framework errors. example: DPP_PACKAGE_EXPORT_INVALID_INPUT anyOf: - type: string - type: integer required: - success - statusCode - errorCode content: description: Error responses do not contain package content. type: 'null' messages: description: Human-readable error details. type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: 0 statusCode: 503 success: false content: null messages: - >- One or more passport files could not be read for export. Please try again. security: - bearer: [] - cookie: [] summary: Export a Battery Passport as a portable DPP package. tags: - Product Passports /v1/dpp-backup/status: get: description: Requires an organisation administrator and the DPP_BACKUP feature. operationId: DppBackupController_status parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: configured: type: boolean counts: type: object patternProperties: ^(.*)$: type: integer lastSuccessfulDeliveryAt: anyOf: - type: string - type: 'null' failed: type: array items: type: object properties: certificateId: type: string lastError: anyOf: - type: string - type: 'null' updatedAt: anyOf: - type: string - type: 'null' required: - certificateId - lastError - updatedAt required: - configured - counts - lastSuccessfulDeliveryAt - failed required: - _meta - messages - content '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get organisation backup status tags: - Independent DPP Backup /v1/dpp-backup/certificate-statuses: post: description: >- Requires an organisation administrator and the DPP_BACKUP feature. Returns status for passports in the current organisation. operationId: DppBackupController_certificateStatuses parameters: [] requestBody: required: true content: application/json: schema: additionalProperties: false type: object properties: certificateIds: minItems: 1 maxItems: 100 uniqueItems: true type: array items: pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ type: string required: - certificateIds example: certificateIds: - 4ac55d01-ec52-499e-9bc3-b5d648ffd88f description: Request payload for Get backup status for passports responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: certificateId: pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ type: string status: anyOf: - const: backed_up type: string - const: pending type: string - const: processing type: string - const: retrying type: string - const: failed type: string - const: not_backed_up type: string - const: not_eligible type: string attemptCount: minimum: 0 type: integer updatedAt: anyOf: - type: string - type: 'null' lastError: anyOf: - type: string - type: 'null' required: - certificateId - status - attemptCount - updatedAt - lastError required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: backed_up attemptCount: 0 updatedAt: updated-at lastError: last-error '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get backup status for passports tags: - Independent DPP Backup /v1/dpp-backup/admin/status: get: description: Platform administrators only. operationId: DppBackupAdminController_adminStatus parameters: - name: limit required: false in: query schema: enum: - 10 - 50 - 100 type: number description: Maximum number of results to return. example: 10 - name: offset required: false in: query schema: type: number description: Zero-based number of results to skip. example: 0 - name: search required: false in: query schema: type: string description: Text used to filter matching results. example: battery responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: configured: type: boolean summary: type: object properties: enabledEntities: minimum: 0 type: integer eligiblePassports: minimum: 0 type: integer backedUpPassports: minimum: 0 type: integer queuedDeliveries: minimum: 0 type: integer failedDeliveries: minimum: 0 type: integer attentionEntities: minimum: 0 type: integer required: - enabledEntities - eligiblePassports - backedUpPassports - queuedDeliveries - failedDeliveries - attentionEntities items: type: array items: type: object properties: id: pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ type: string name: type: string status: anyOf: - const: healthy type: string - const: processing type: string - const: attention type: string - const: no_passports type: string eligiblePassports: minimum: 0 type: integer backedUpPassports: minimum: 0 type: integer queuedDeliveries: minimum: 0 type: integer failedDeliveries: minimum: 0 type: integer lastSuccessfulDeliveryAt: anyOf: - type: string - type: 'null' lastError: anyOf: - type: string - type: 'null' lastErrorAt: anyOf: - type: string - type: 'null' required: - id - name - status - eligiblePassports - backedUpPassports - queuedDeliveries - failedDeliveries - lastSuccessfulDeliveryAt - lastError - lastErrorAt total: minimum: 0 type: integer required: - configured - summary - items - total required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: configured: true summary: enabledEntities: 0 eligiblePassports: 0 backedUpPassports: 0 queuedDeliveries: 0 failedDeliveries: 0 attentionEntities: 0 items: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name status: healthy eligiblePassports: 0 backedUpPassports: 0 queuedDeliveries: 0 failedDeliveries: 0 lastSuccessfulDeliveryAt: last-successful-delivery-at lastError: last-error lastErrorAt: last-error-at total: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get backup status across organisations tags: - Independent DPP Backup /v1/dpp-backup/recovery-tokens: get: description: >- Organisation administrators only. Lists tokens for the current organisation without revealing their secrets. operationId: DppBackupRecoveryController_listRecoveryTokens[0] parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: id: type: string label: type: string sourcePrincipalId: type: string tokenPrefix: type: string scopes: type: array items: type: string expiresAt: anyOf: - type: string - type: 'null' createdAt: type: string status: type: string lastUsedAt: anyOf: - type: string - type: 'null' revokedAt: anyOf: - type: string - type: 'null' required: - id - label - sourcePrincipalId - tokenPrefix - scopes - expiresAt - createdAt - status - lastUsedAt - revokedAt required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f label: label sourcePrincipalId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f tokenPrefix: opaque-token scopes: - scopes expiresAt: expires-at createdAt: created-at status: published lastUsedAt: last-used-at revokedAt: revoked-at '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: List recovery tokens tags: - Independent DPP Backup post: description: >- Requires an organisation administrator and the DPP_BACKUP feature. Creates read-only recovery access to the organisation backed up with the independent provider. operationId: DppBackupRecoveryController_issueRecoveryToken[0] parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false type: object properties: label: minLength: 1 maxLength: 255 type: string expiresAt: pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{1,9})?(?:Z|[+-]\d{2}:\d{2})$ type: string required: - label description: Request payload for Issue a recovery token responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: type: string label: type: string sourcePrincipalId: type: string tokenPrefix: type: string scopes: type: array items: type: string expiresAt: anyOf: - type: string - type: 'null' createdAt: type: string token: type: string required: - id - label - sourcePrincipalId - tokenPrefix - scopes - expiresAt - createdAt - token required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f label: label sourcePrincipalId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f tokenPrefix: opaque-token scopes: - scopes expiresAt: expires-at createdAt: created-at token: opaque-token '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Issue a recovery token tags: - Independent DPP Backup /v1/dpp-backups/recovery-tokens: get: description: >- Organisation administrators only. Lists tokens for the current organisation without revealing their secrets. operationId: DppBackupRecoveryController_listRecoveryTokens[1] parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: type: object properties: id: type: string label: type: string sourcePrincipalId: type: string tokenPrefix: type: string scopes: type: array items: type: string expiresAt: anyOf: - type: string - type: 'null' createdAt: type: string status: type: string lastUsedAt: anyOf: - type: string - type: 'null' revokedAt: anyOf: - type: string - type: 'null' required: - id - label - sourcePrincipalId - tokenPrefix - scopes - expiresAt - createdAt - status - lastUsedAt - revokedAt required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f label: label sourcePrincipalId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f tokenPrefix: opaque-token scopes: - scopes expiresAt: expires-at createdAt: created-at status: published lastUsedAt: last-used-at revokedAt: revoked-at '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: List recovery tokens tags: - Independent DPP Backup post: description: >- Requires an organisation administrator and the DPP_BACKUP feature. Creates read-only recovery access to the organisation backed up with the independent provider. operationId: DppBackupRecoveryController_issueRecoveryToken[1] parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false type: object properties: label: minLength: 1 maxLength: 255 type: string expiresAt: pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{1,9})?(?:Z|[+-]\d{2}:\d{2})$ type: string required: - label description: Request payload for Issue a recovery token responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: type: string label: type: string sourcePrincipalId: type: string tokenPrefix: type: string scopes: type: array items: type: string expiresAt: anyOf: - type: string - type: 'null' createdAt: type: string token: type: string required: - id - label - sourcePrincipalId - tokenPrefix - scopes - expiresAt - createdAt - token required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f label: label sourcePrincipalId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f tokenPrefix: opaque-token scopes: - scopes expiresAt: expires-at createdAt: created-at token: opaque-token '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Issue a recovery token tags: - Independent DPP Backup /v1/dpp-backup/recovery-tokens/{tokenId}/actions/revoke: post: description: >- Organisation administrators only. Revokes a token belonging to the current organisation. operationId: DppBackupRecoveryController_revokeRecoveryToken[0] parameters: - name: tokenId required: true in: path schema: type: string description: Token identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: type: string status: type: string revokedAt: anyOf: - type: string - type: 'null' required: - id - status - revokedAt required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: published revokedAt: revoked-at '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Revoke a recovery token tags: - Independent DPP Backup /v1/dpp-backups/recovery-tokens/{tokenId}/actions/revoke: post: description: >- Organisation administrators only. Revokes a token belonging to the current organisation. operationId: DppBackupRecoveryController_revokeRecoveryToken[1] parameters: - name: tokenId required: true in: path schema: type: string description: Token identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: type: string status: type: string revokedAt: anyOf: - type: string - type: 'null' required: - id - status - revokedAt required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: published revokedAt: revoked-at '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Revoke a recovery token tags: - Independent DPP Backup /v1/back-office/dpp-backups: get: description: Platform administrators only. operationId: DppBackupOperationsController_list parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: items: type: array items: type: object properties: id: type: string status: type: string sourceEntityId: type: string certificateId: type: string desiredRevision: type: string deliveredRevision: type: string staticHash: anyOf: - type: string - type: 'null' updatedAt: anyOf: - type: string - type: 'null' providerReceiptId: anyOf: - type: string - type: 'null' dynamicCursor: {} lastError: anyOf: - type: string - type: 'null' required: - id - status - sourceEntityId - certificateId - desiredRevision - deliveredRevision - staticHash - updatedAt - providerReceiptId - dynamicCursor - lastError total: type: integer required: - items - total required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: items: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: published sourceEntityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f desiredRevision: desired-revision deliveredRevision: delivered-revision staticHash: static-hash updatedAt: updated-at providerReceiptId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f dynamicCursor: dynamic-cursor lastError: last-error total: 0 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: List backup deliveries tags: - Independent DPP Backup /v1/back-office/dpp-backups/{deliveryId}: get: description: Platform administrators only. operationId: DppBackupOperationsController_detail parameters: - name: deliveryId required: true in: path schema: type: string description: Delivery identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: id: type: string status: type: string sourceEntityId: type: string certificateId: type: string desiredRevision: type: string deliveredRevision: type: string staticHash: anyOf: - type: string - type: 'null' updatedAt: anyOf: - type: string - type: 'null' providerReceiptId: anyOf: - type: string - type: 'null' dynamicCursor: {} lastError: anyOf: - type: string - type: 'null' required: - id - status - sourceEntityId - certificateId - desiredRevision - deliveredRevision - staticHash - updatedAt - providerReceiptId - dynamicCursor - lastError required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f status: published sourceEntityId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f certificateId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f desiredRevision: desired-revision deliveredRevision: delivered-revision staticHash: static-hash updatedAt: updated-at providerReceiptId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f dynamicCursor: dynamic-cursor lastError: last-error '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Get a backup delivery tags: - Independent DPP Backup /v1/back-office/dpp-backups/{deliveryId}/actions/retry: post: description: Platform administrators only. operationId: DppBackupOperationsController_retry parameters: - name: deliveryId required: true in: path schema: type: string description: Delivery identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Retry a failed passport backup tags: - Independent DPP Backup /v1/external-data-requests/public/entities: get: description: Returns only opted-in entities after at least three search characters. operationId: ExternalDataRequestPublicController_findEntities parameters: - name: search required: true in: query schema: minLength: 3 maxLength: 255 description: Case-insensitive entity name prefix or fragment. examples: - mine type: string description: Case-insensitive entity name prefix or fragment. example: mine responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: Opted-in entities matching the public search. type: array items: type: object properties: id: description: Entity identifier. type: string name: description: Entity display name. type: string country: description: ISO country code when available. anyOf: - type: string - type: 'null' required: - id - name - country required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name country: country '400': description: The request body, parameters, or query are invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '429': description: The public request rate limit was exceeded. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 429 errorCode: 0 messages: - HTTP 429 error. content: null security: [] summary: Search entities accepting external requests tags: - External Data Requests /v1/external-data-requests/public/entities/{entityId}/materials: get: description: >- Returns active standard and accessible custom materials after validating that the target entity accepts requests. operationId: ExternalDataRequestPublicController_findMaterials parameters: - name: entityId required: true in: path description: Opted-in target entity identifier. schema: example: 8b75f6b8-0e40-4b78-8890-22d91abcc123 type: string example: 8b75f6b8-0e40-4b78-8890-22d91abcc123 - name: search required: false in: query schema: maxLength: 255 description: Case-insensitive material name filter. examples: - copper type: string description: Case-insensitive material name filter. example: copper - name: offset required: false in: query schema: pattern: ^[0-9]+$ type: string description: Zero-based number of results to skip. example: '0' - name: limit required: false in: query schema: pattern: ^[1-9][0-9]*$ type: string description: Maximum number of results to return. example: '1' responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: description: >- Standard Minespider materials. Customer-owned materials are never exposed. type: array items: type: object properties: id: description: Standard material identifier. type: string name: description: Standard material display name. type: string required: - id - name required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f name: name '400': description: The request body, parameters, or query are invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '404': description: The entity does not accept external data requests. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '429': description: The public request rate limit was exceeded. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 429 errorCode: 0 messages: - HTTP 429 error. content: null security: [] summary: List available request materials tags: - External Data Requests /v1/external-data-requests/public/requests: post: description: >- Creates a pending-verification request and queues a one-time email verification link. operationId: ExternalDataRequestPublicController_submitRequest parameters: [] requestBody: required: true content: application/json: schema: additionalProperties: false type: object properties: requesterName: minLength: 1 maxLength: 255 description: Requester full name. examples: - Ada Lovelace type: string requesterEmail: minLength: 3 maxLength: 320 description: Work email that receives verification and status links. examples: - ada@example.com type: string requesterOrganisation: minLength: 1 maxLength: 255 description: Organisation represented by the requester. examples: - Example Industries type: string requesterCountry: minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 requester country code. examples: - PT type: string entityId: minLength: 1 maxLength: 36 description: Opted-in Minespider entity receiving the request. examples: - 8b75f6b8-0e40-4b78-8890-22d91abcc123 type: string certificateTypes: minItems: 1 maxItems: 2 uniqueItems: true type: array items: description: >- Supported passport type. This release accepts Product Passports and Entity Certificates only. examples: - product-passport anyOf: - const: product-passport type: string - const: entity type: string publishedFrom: minimum: 0 description: >- Inclusive publication date lower bound as Unix epoch milliseconds. examples: - 1767225600000 type: integer publishedTo: minimum: 0 description: >- Inclusive publication date upper bound as Unix epoch milliseconds. examples: - 1798761599999 type: integer materialIds: uniqueItems: true description: >- Optional available material identifiers used to match Product Passports. examples: - - copper-material-id type: array items: minLength: 1 maxLength: 36 type: string visibilityLayers: minItems: 1 maxItems: 3 uniqueItems: true type: array items: description: Requested or approved disclosure layer. examples: - public - transparent anyOf: - const: public type: string - const: transparent type: string - const: private type: string purpose: minLength: 1 maxLength: 4000 description: Business reason for requesting the data. examples: - Supplier due diligence type: string agreementAccepted: description: Confirms acceptance of the displayed requester agreement. const: true type: boolean honeypot: maxLength: 0 description: >- Bot-trap field. Human clients must omit it or send an empty value. type: string required: - requesterName - requesterEmail - requesterOrganisation - requesterCountry - entityId - certificateTypes - publishedFrom - publishedTo - materialIds - visibilityLayers - purpose - agreementAccepted example: requesterName: Ada Lovelace requesterEmail: ada@example.com requesterOrganisation: Example Industries requesterCountry: PT entityId: 8b75f6b8-0e40-4b78-8890-22d91abcc123 certificateTypes: - product-passport publishedFrom: 1767225600000 publishedTo: 1798761599999 materialIds: - copper-material-id visibilityLayers: - public purpose: Supplier due diligence agreementAccepted: true honeypot: '' description: Request payload for Submit an external passport data request responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: reference: examples: - EDR-4A1B2C3D type: string status: description: Current external data request lifecycle state. examples: - PENDING anyOf: - const: PENDING_VERIFICATION type: string - const: PENDING type: string - const: INFORMATION_REQUESTED type: string - const: APPROVED type: string - const: DECLINED type: string - const: WITHDRAWN type: string - const: REVOKED type: string - const: EXPIRED type: string required: - reference - status required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: reference: EDR-4A1B2C3D status: PENDING '400': description: The request body, parameters, or query are invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '404': description: The selected entity does not accept requests. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '429': description: The public request rate limit was exceeded. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 429 errorCode: 0 messages: - HTTP 429 error. content: null security: [] summary: Submit an external passport data request tags: - External Data Requests /v1/external-data-requests/public/access-links: post: description: >- Always returns the same accepted response. If the reference and email match, a suitable verification, status, or access link is queued. operationId: ExternalDataRequestPublicController_requestFreshLink parameters: [] requestBody: required: true content: application/json: schema: additionalProperties: false type: object properties: reference: minLength: 1 maxLength: 64 description: External request reference. examples: - EDR-4A1B2C3D type: string requesterEmail: minLength: 3 maxLength: 320 description: Email originally used for the request. examples: - ada@example.com type: string honeypot: maxLength: 0 description: >- Bot-trap field. Human clients must omit it or send an empty value. type: string required: - reference - requesterEmail example: reference: EDR-4A1B2C3D requesterEmail: ada@example.com honeypot: '' description: Request payload for Request a fresh external data request link responses: '202': description: Request accepted for asynchronous processing. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 202 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: accepted: description: >- The same response is returned whether a matching request exists, preventing account enumeration. const: true type: boolean required: - accepted required: - _meta - messages - content example: _meta: success: true statusCode: 202 messages: - Success content: accepted: true '400': description: The request body, parameters, or query are invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '429': description: The public request rate limit was exceeded. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 429 errorCode: 0 messages: - HTTP 429 error. content: null security: [] summary: Request a fresh external data request link tags: - External Data Requests /v1/external-data-requests/public/access-links/{token}/exchange: post: description: >- Consumes the token once and sets an HttpOnly cookie scoped to external data request routes. Tokens must not be logged or reused. operationId: ExternalDataRequestPublicController_exchangeLink parameters: - name: token required: true in: path description: Opaque single-use token received by email. schema: example: opaque-one-time-token type: string example: opaque-one-time-token - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: destination: anyOf: - const: /request-data/status type: string - const: /request-data/report type: string expiresAt: description: External session expiry as Unix epoch milliseconds. type: integer required: - destination - expiresAt required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: destination: /request-data/status expiresAt: 0 '400': description: The request body, parameters, or query are invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: >- The token is invalid, expired, already consumed, or no longer has an active grant. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '429': description: The public request rate limit was exceeded. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 429 errorCode: 0 messages: - HTTP 429 error. content: null security: [] summary: Exchange a one-time link for an external session tags: - External Data Requests /v1/external-data-requests/admin/requests: get: description: Returns a tenant-scoped, paginated administrator queue. operationId: ExternalDataRequestAdminController_list parameters: - name: page required: false in: query schema: pattern: ^[1-9][0-9]*$ type: string description: One-based page number. example: '1' - name: pageSize required: false in: query schema: pattern: ^[1-9][0-9]*$ type: string description: Number of results per page. example: '1' - name: status required: false in: query schema: anyOf: - const: PENDING_VERIFICATION type: string - const: PENDING type: string - const: INFORMATION_REQUESTED type: string - const: APPROVED type: string - const: DECLINED type: string - const: WITHDRAWN type: string - const: REVOKED type: string - const: EXPIRED type: string description: Filter by lifecycle status. example: PENDING_VERIFICATION - name: search required: false in: query schema: maxLength: 255 description: Search reference, requester, organisation, or email. type: string description: Search reference, requester, organisation, or email. example: battery - name: order required: false in: query schema: pattern: >- ^-?(reference|requesterName|requesterOrganisation|status|createdAt)(,-?(reference|requesterName|requesterOrganisation|status|createdAt))*$ type: string description: Result ordering expression. example: '-createdAt' responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: items: type: array items: description: Administrator queue row. type: object properties: id: type: string reference: type: string requesterName: type: string requesterOrganisation: type: string requesterCountry: type: string certificateTypes: type: array items: type: string status: description: Current external data request lifecycle state. examples: - PENDING anyOf: - const: PENDING_VERIFICATION type: string - const: PENDING type: string - const: INFORMATION_REQUESTED type: string - const: APPROVED type: string - const: DECLINED type: string - const: WITHDRAWN type: string - const: REVOKED type: string - const: EXPIRED type: string createdAt: type: integer updatedAt: anyOf: - type: integer - type: 'null' required: - id - reference - requesterName - requesterOrganisation - requesterCountry - certificateTypes - status - createdAt - updatedAt total: minimum: 0 type: integer page: minimum: 1 type: integer pageSize: minimum: 1 type: integer required: - items - total - page - pageSize required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: items: - id: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f reference: reference requesterName: requester-name requesterOrganisation: requester-organisation requesterCountry: requester-country certificateTypes: - certificate-types status: PENDING createdAt: 0 updatedAt: 0 total: 0 page: 1 pageSize: 1 '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- An active administrator membership and the EXTERNAL_DATA_REQUESTS feature are required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null security: - bearer: [] - cookie: [] summary: List external data requests tags: - External Data Requests - Admin /v1/external-data-requests/admin/requests/{requestId}: get: description: >- Returns the request criteria, conversation history, audit events, grants, and frozen approved items for the administrator's entity. operationId: ExternalDataRequestAdminController_get parameters: - name: requestId required: true in: path description: External request identifier. schema: example: 82b7c7cb-a123-4038-9e14-8cb851a96442 type: string example: 82b7c7cb-a123-4038-9e14-8cb851a96442 responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: additionalProperties: true description: >- Complete tenant-scoped request review, including criteria, events, grants, frozen disclosure items, and material names. examples: - id: request-id reference: EDR-4A1B2C3D status: PENDING events: [] grants: [] type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: request-id reference: EDR-4A1B2C3D status: PENDING events: [] grants: [] '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- An active administrator membership and the EXTERNAL_DATA_REQUESTS feature are required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: No request exists in the administrator's entity. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null security: - bearer: [] - cookie: [] summary: Get an external data request for review tags: - External Data Requests - Admin /v1/external-data-requests/admin/requests/{requestId}/candidates: get: description: >- Returns exact eligible Product Passport and Entity Certificate versions matching the stored request criteria. operationId: ExternalDataRequestAdminController_candidates parameters: - name: requestId required: true in: path description: External request identifier. schema: example: 82b7c7cb-a123-4038-9e14-8cb851a96442 type: string example: 82b7c7cb-a123-4038-9e14-8cb851a96442 responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: array items: additionalProperties: true description: >- Eligible exact passport version with suggested layers and attachments. examples: - certificateId: certificate-id certificateVersion: 3 certificateType: product-passport type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: - certificateId: certificate-id certificateVersion: 3 certificateType: product-passport '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- An active administrator membership and the EXTERNAL_DATA_REQUESTS feature are required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: No request exists in the administrator's entity. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null security: - bearer: [] - cookie: [] summary: Resolve eligible passport candidates tags: - External Data Requests - Admin /v1/external-data-requests/admin/requests/{requestId}/audit.csv: get: description: Exports append-only request events with actor and JSON payload evidence. operationId: ExternalDataRequestAdminController_audit parameters: - name: requestId required: true in: path description: External request identifier. schema: example: 82b7c7cb-a123-4038-9e14-8cb851a96442 type: string example: 82b7c7cb-a123-4038-9e14-8cb851a96442 responses: '200': description: UTF-8 CSV audit file. content: text/csv: schema: type: string format: binary '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- An active administrator membership and the EXTERNAL_DATA_REQUESTS feature are required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: No request exists in the administrator's entity. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null security: - bearer: [] - cookie: [] summary: Download the request audit trail tags: - External Data Requests - Admin /v1/external-data-requests/admin/requests/{requestId}/actions: post: description: >- Approve an exact passport scope, decline, request more information, or revoke active access. State is revalidated transactionally. operationId: ExternalDataRequestAdminController_action parameters: - name: requestId required: true in: path description: External request identifier. schema: example: 82b7c7cb-a123-4038-9e14-8cb851a96442 type: string example: 82b7c7cb-a123-4038-9e14-8cb851a96442 - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: anyOf: - additionalProperties: false type: object properties: type: const: approve type: string expiresAt: minimum: 1 description: Grant expiry as Unix epoch milliseconds. examples: - 1798761599999 type: integer items: minItems: 1 type: array items: additionalProperties: false type: object properties: certificateId: minLength: 1 maxLength: 36 description: Exact candidate certificate identifier. examples: - a65dedf0-9f2a-4a54-93ce-1f36120f9123 type: string certificateVersion: minimum: 0 description: >- Exact immutable certificate version reviewed by the approver. examples: - 3 type: integer approvedLayers: minItems: 1 maxItems: 3 uniqueItems: true type: array items: description: Requested or approved disclosure layer. examples: - public - transparent anyOf: - const: public type: string - const: transparent type: string - const: private type: string attachmentIds: uniqueItems: true description: >- Attachments explicitly approved from the selected visibility layers. examples: - - 40d76857-0142-43de-9598-f4eb81990f00 type: array items: minLength: 1 maxLength: 36 type: string required: - certificateId - certificateVersion - approvedLayers - attachmentIds required: - type - expiresAt - items - additionalProperties: false type: object properties: type: const: decline type: string reason: minLength: 1 maxLength: 4000 description: Reason shown to the requester. type: string required: - type - reason - additionalProperties: false type: object properties: type: const: request-information type: string message: minLength: 1 maxLength: 4000 description: Question shown to the requester. type: string required: - type - message - additionalProperties: false type: object properties: type: const: revoke type: string reason: minLength: 1 maxLength: 4000 description: Reason shown to the requester. type: string required: - type - reason example: type: approve expiresAt: 1798761599999 items: - certificateId: a65dedf0-9f2a-4a54-93ce-1f36120f9123 certificateVersion: 3 approvedLayers: - public attachmentIds: - 40d76857-0142-43de-9598-f4eb81990f00 description: Request payload for Apply an administrator decision responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: additionalProperties: true description: Resulting request or grant state after the action. examples: - status: APPROVED grantId: grant-id type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: status: APPROVED grantId: grant-id '400': description: >- The selected scope, layers, attachments, expiry, or message is invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- An active administrator membership and the EXTERNAL_DATA_REQUESTS feature are required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: The request or an approved passport is unavailable. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '409': description: The request state changed and no longer permits this action. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 409 errorCode: 0 messages: - The request conflicts with the current resource state. content: null security: - bearer: [] - cookie: [] summary: Apply an administrator decision tags: - External Data Requests - Admin /v1/external-data-requests/admin/settings: get: description: >- Returns whether the caller's entity is publicly discoverable and currently accepts external data requests. operationId: ExternalDataRequestAdminController_settings parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: acceptExternalDataRequests: type: boolean required: - acceptExternalDataRequests required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: acceptExternalDataRequests: true '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- An active administrator membership and the EXTERNAL_DATA_REQUESTS feature are required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null security: - bearer: [] - cookie: [] summary: Read external request settings tags: - External Data Requests - Admin patch: description: >- Controls whether this entity is publicly discoverable and accepts new requests. operationId: ExternalDataRequestAdminController_updateSettings parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: additionalProperties: false type: object properties: acceptExternalDataRequests: description: >- Whether this entity appears in public discovery and accepts new external requests. examples: - true type: boolean required: - acceptExternalDataRequests example: acceptExternalDataRequests: true description: Request payload for Update external request settings responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: acceptExternalDataRequests: type: boolean required: - acceptExternalDataRequests required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: acceptExternalDataRequests: true '400': description: The settings body is invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: >- An active administrator membership and the EXTERNAL_DATA_REQUESTS feature are required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null security: - bearer: [] - cookie: [] summary: Update external request settings tags: - External Data Requests - Admin /v1/external-data-requests/external/context: get: description: >- Returns the current request status and conversation; active approved sessions also receive frozen disclosure item summaries. operationId: ExternalDataRequestExternalController_context parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: additionalProperties: true description: >- Requester-visible request status and, for an active grant, the approved frozen item summaries. examples: - reference: EDR-4A1B2C3D status: APPROVED grants: [] type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: reference: EDR-4A1B2C3D status: APPROVED grants: [] '401': description: A valid, unexpired external request session is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: 0 messages: - External access is not available. content: null '409': description: The request or grant is no longer available. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 409 errorCode: 0 messages: - The request conflicts with the current resource state. content: null security: - external_data_request_session: [] summary: Read requester context tags: - External Data Requests - Requester /v1/external-data-requests/external/report.csv: get: description: Exports only the frozen values and layers approved in the active grant. operationId: ExternalDataRequestExternalController_exportCsv parameters: [] responses: '200': description: UTF-8 disclosure CSV file. content: text/csv: schema: type: string format: binary '401': description: A valid, unexpired external request session is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: 0 messages: - External access is not available. content: null security: - external_data_request_session: [] summary: Download approved disclosure CSV tags: - External Data Requests - Requester /v1/external-data-requests/external/items/{itemId}/attachments/{attachmentId}: get: description: >- Streams an attachment only when its certificate, checksum, visibility layer, and frozen manifest still match the active grant. operationId: ExternalDataRequestExternalController_attachment parameters: - name: itemId required: true in: path description: Frozen disclosure item identifier. schema: example: disclosure-item-id type: string example: disclosure-item-id - name: attachmentId required: true in: path description: Approved attachment identifier. schema: example: attachment-id type: string example: attachment-id responses: '200': description: Attachment stream. content: application/octet-stream: schema: type: string format: binary '401': description: A valid, unexpired external request session is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: 0 messages: - External access is not available. content: null security: - external_data_request_session: [] summary: Download an approved attachment tags: - External Data Requests - Requester /v1/external-data-requests/external/items/{itemId}: get: description: Returns the exact allowlisted snapshot approved for this requester. operationId: ExternalDataRequestExternalController_item parameters: - name: itemId required: true in: path description: Frozen disclosure item identifier. schema: example: disclosure-item-id type: string example: disclosure-item-id responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: additionalProperties: true description: >- Frozen allowlisted snapshot for one approved passport item. examples: - id: item-id certificateType: ProductPassport approvedLayers: - public type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: id: item-id certificateType: ProductPassport approvedLayers: - public '401': description: The item is outside the active grant or the grant has expired. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: 0 messages: - External access is not available. content: null security: - external_data_request_session: [] summary: Read one frozen disclosure item tags: - External Data Requests - Requester /v1/external-data-requests/external/actions: post: description: >- Allows an accountless requester to answer an information request or withdraw a still-open request. operationId: ExternalDataRequestExternalController_action parameters: - name: Idempotency-Key in: header description: >- Optional key (1–128 printable ASCII characters without whitespace). Reuse the same key with the same authorized operation and input to replay the original result (Idempotency-Replayed: true). A different operation or input returns 409 IDEMPOTENCY_KEY_CONFLICT. Lock contention returns 409 IDEMPOTENCY_IN_PROGRESS with Retry-After: 1; retry the same key. A transient failure before any effect can also be retried with the same key. Once an external effect is admitted, an unknown outcome returns 409 IDEMPOTENCY_OUTCOME_UNRESOLVED, including for concurrent requests; reconcile the original operation before retrying and do not use a new key. Terminal results and retryable admissions without effects are retained for at least seven days; unresolved operations remain until reconciled. required: false schema: type: string example: metadata.key requestBody: required: true content: application/json: schema: anyOf: - additionalProperties: false type: object properties: type: const: respond-information type: string message: minLength: 1 maxLength: 4000 description: >- Requester response to the administrator's latest question. type: string required: - type - message - additionalProperties: false type: object properties: type: const: withdraw type: string required: - type example: type: respond-information message: message description: Request payload for Respond to or withdraw a request responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: additionalProperties: true description: Resulting request or grant state after the action. examples: - status: APPROVED grantId: grant-id type: object properties: {} required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: status: APPROVED grantId: grant-id '400': description: The action body is invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: A valid, unexpired external request session is required. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: 0 messages: - External access is not available. content: null '409': description: The request state no longer permits the action. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 409 errorCode: 0 messages: - The request conflicts with the current resource state. content: null security: - external_data_request_session: [] summary: Respond to or withdraw a request tags: - External Data Requests - Requester /v1/logs/export: get: description: >- Returns a JSON envelope with meta and a base64-encoded CSV. Meta includes filtered certificate IDs and totals. operationId: LogsController_export parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: filename: type: string csvBase64: description: CSV content encoded in base64 type: string required: - filename - csvBase64 required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: filename: passport.pdf csvBase64: csv-base64 '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null security: - bearer: [] - cookie: [] summary: Export logs as CSV tags: - Logs /v1/dpps/{dppId}: get: description: >- Returns the requested public Battery DPP in compressed or expanded form. An HTML request is redirected to the passport's public URL. operationId: CertificateDppController_readByDigitalProductPassportId parameters: - name: dppId required: true in: path schema: type: string description: Dpp identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: representation required: false in: query schema: anyOf: - const: compressed type: string - const: full type: string description: Representation value used by this operation. example: compressed responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - additionalProperties: true type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - additionalProperties: false type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string elements: type: array items: anyOf: - type: object properties: elementId: type: string objectType: const: DataElementCollection type: string elements: minItems: 1 type: array items: $ref: >- #/paths/~1v1~1dpps~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - elements - type: object properties: elementId: type: string objectType: const: SingleValuedDataElement type: string valueDataType: type: string value: anyOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: >- #/paths/~1v1~1dpps~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value - type: object patternProperties: ^(.*)$: $ref: >- #/paths/~1v1~1dpps~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value required: - elementId - objectType - valueDataType - value - type: object properties: elementId: type: string objectType: const: MultiValuedDataElement type: string valueDataType: type: string value: type: array items: $ref: >- #/paths/~1v1~1dpps~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - value - type: object properties: elementId: type: string objectType: const: RelatedResource type: string contentType: type: string url: type: string language: type: string resourceTitle: type: string required: - elementId - objectType - contentType - url required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - elements required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: digitalProductPassportId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f uniqueProductIdentifier: unique-product-identifier dppSchemaVersion: dpp-schema-version lastUpdated: '2026-08-25T12:00:00.000Z' text/html: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - additionalProperties: true type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - additionalProperties: false type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string elements: type: array items: anyOf: - type: object properties: elementId: type: string objectType: const: DataElementCollection type: string elements: minItems: 1 type: array items: $ref: >- #/paths/~1v1~1dpps~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - elements - type: object properties: elementId: type: string objectType: const: SingleValuedDataElement type: string valueDataType: type: string value: anyOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: >- #/paths/~1v1~1dpps~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value - type: object patternProperties: ^(.*)$: $ref: >- #/paths/~1v1~1dpps~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value required: - elementId - objectType - valueDataType - value - type: object properties: elementId: type: string objectType: const: MultiValuedDataElement type: string valueDataType: type: string value: type: array items: $ref: >- #/paths/~1v1~1dpps~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - value - type: object properties: elementId: type: string objectType: const: RelatedResource type: string contentType: type: string url: type: string language: type: string resourceTitle: type: string required: - elementId - objectType - contentType - url required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - elements required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: digitalProductPassportId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f uniqueProductIdentifier: unique-product-identifier dppSchemaVersion: dpp-schema-version lastUpdated: '2026-08-25T12:00:00.000Z' '400': description: >- Invalid battery DPP JSON header or structure; HTML navigation is unaffected. content: application/json: schema: type: object properties: _meta: type: object properties: errorCode: const: BATTERY_DPP_VALIDATION_FAILED type: string statusCode: const: 400 type: number success: const: false type: boolean validationIssues: type: array items: type: object properties: code: anyOf: - const: DPP_HEADER_REQUIRED type: string - const: DPP_HEADER_TYPE_INVALID type: string - const: DPP_GRANULARITY_INVALID type: string - const: DPP_TIMESTAMP_INVALID type: string - const: DPP_RESERVED_NAME_CONFLICT type: string - const: DPP_ELEMENT_PATH_COLLISION type: string - const: DPP_COLLECTION_EMPTY type: string - const: DPP_ARRAY_TYPES_MIXED type: string path: type: array items: type: string fieldKeys: type: array items: type: string sectionKey: type: string fieldLabels: type: array items: type: object properties: key: type: string i18nId: type: string fallback: type: string required: - key required: - code - path - fieldKeys required: - errorCode - statusCode - success content: type: 'null' messages: type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: BATTERY_DPP_VALIDATION_FAILED statusCode: 400 success: false content: null messages: - messages text/html: schema: type: object properties: _meta: type: object properties: errorCode: const: BATTERY_DPP_VALIDATION_FAILED type: string statusCode: const: 400 type: number success: const: false type: boolean validationIssues: type: array items: type: object properties: code: anyOf: - const: DPP_HEADER_REQUIRED type: string - const: DPP_HEADER_TYPE_INVALID type: string - const: DPP_GRANULARITY_INVALID type: string - const: DPP_TIMESTAMP_INVALID type: string - const: DPP_RESERVED_NAME_CONFLICT type: string - const: DPP_ELEMENT_PATH_COLLISION type: string - const: DPP_COLLECTION_EMPTY type: string - const: DPP_ARRAY_TYPES_MIXED type: string path: type: array items: type: string fieldKeys: type: array items: type: string sectionKey: type: string fieldLabels: type: array items: type: object properties: key: type: string i18nId: type: string fallback: type: string required: - key required: - code - path - fieldKeys required: - errorCode - statusCode - success content: type: 'null' messages: type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: BATTERY_DPP_VALIDATION_FAILED statusCode: 400 success: false content: null messages: - messages '409': description: >- The preserved schema is invalid or inconsistent with the archived schema version. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 409 errorCode: 0 messages: - The request conflicts with the current resource state. content: null security: [] summary: Read Battery DPP by digital product passport ID. tags: - Product Passports /v1/dppsByProductId/{productId}: get: description: >- Returns the latest published Battery DPP marked Active under the managed battery lifecycle policy (case-insensitive). Returns 404 when no active DPP qualifies. An HTML request is redirected to the passport's public URL. operationId: CertificateDppController_readByUniqueProductIdentifier parameters: - name: productId required: true in: path schema: type: string description: Product identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: representation required: false in: query schema: anyOf: - const: compressed type: string - const: full type: string description: Representation value used by this operation. example: compressed responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - additionalProperties: true type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - additionalProperties: false type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string elements: type: array items: anyOf: - type: object properties: elementId: type: string objectType: const: DataElementCollection type: string elements: minItems: 1 type: array items: $ref: >- #/paths/~1v1~1dppsByProductId~1{productId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - elements - type: object properties: elementId: type: string objectType: const: SingleValuedDataElement type: string valueDataType: type: string value: anyOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: >- #/paths/~1v1~1dppsByProductId~1{productId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value - type: object patternProperties: ^(.*)$: $ref: >- #/paths/~1v1~1dppsByProductId~1{productId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value required: - elementId - objectType - valueDataType - value - type: object properties: elementId: type: string objectType: const: MultiValuedDataElement type: string valueDataType: type: string value: type: array items: $ref: >- #/paths/~1v1~1dppsByProductId~1{productId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - value - type: object properties: elementId: type: string objectType: const: RelatedResource type: string contentType: type: string url: type: string language: type: string resourceTitle: type: string required: - elementId - objectType - contentType - url required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - elements required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: digitalProductPassportId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f uniqueProductIdentifier: unique-product-identifier dppSchemaVersion: dpp-schema-version lastUpdated: '2026-08-25T12:00:00.000Z' text/html: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - additionalProperties: true type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - additionalProperties: false type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string elements: type: array items: anyOf: - type: object properties: elementId: type: string objectType: const: DataElementCollection type: string elements: minItems: 1 type: array items: $ref: >- #/paths/~1v1~1dppsByProductId~1{productId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - elements - type: object properties: elementId: type: string objectType: const: SingleValuedDataElement type: string valueDataType: type: string value: anyOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: >- #/paths/~1v1~1dppsByProductId~1{productId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value - type: object patternProperties: ^(.*)$: $ref: >- #/paths/~1v1~1dppsByProductId~1{productId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value required: - elementId - objectType - valueDataType - value - type: object properties: elementId: type: string objectType: const: MultiValuedDataElement type: string valueDataType: type: string value: type: array items: $ref: >- #/paths/~1v1~1dppsByProductId~1{productId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - value - type: object properties: elementId: type: string objectType: const: RelatedResource type: string contentType: type: string url: type: string language: type: string resourceTitle: type: string required: - elementId - objectType - contentType - url required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - elements required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: digitalProductPassportId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f uniqueProductIdentifier: unique-product-identifier dppSchemaVersion: dpp-schema-version lastUpdated: '2026-08-25T12:00:00.000Z' '400': description: >- Invalid battery DPP JSON header or structure; HTML navigation is unaffected. content: application/json: schema: type: object properties: _meta: type: object properties: errorCode: const: BATTERY_DPP_VALIDATION_FAILED type: string statusCode: const: 400 type: number success: const: false type: boolean validationIssues: type: array items: type: object properties: code: anyOf: - const: DPP_HEADER_REQUIRED type: string - const: DPP_HEADER_TYPE_INVALID type: string - const: DPP_GRANULARITY_INVALID type: string - const: DPP_TIMESTAMP_INVALID type: string - const: DPP_RESERVED_NAME_CONFLICT type: string - const: DPP_ELEMENT_PATH_COLLISION type: string - const: DPP_COLLECTION_EMPTY type: string - const: DPP_ARRAY_TYPES_MIXED type: string path: type: array items: type: string fieldKeys: type: array items: type: string sectionKey: type: string fieldLabels: type: array items: type: object properties: key: type: string i18nId: type: string fallback: type: string required: - key required: - code - path - fieldKeys required: - errorCode - statusCode - success content: type: 'null' messages: type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: BATTERY_DPP_VALIDATION_FAILED statusCode: 400 success: false content: null messages: - messages text/html: schema: type: object properties: _meta: type: object properties: errorCode: const: BATTERY_DPP_VALIDATION_FAILED type: string statusCode: const: 400 type: number success: const: false type: boolean validationIssues: type: array items: type: object properties: code: anyOf: - const: DPP_HEADER_REQUIRED type: string - const: DPP_HEADER_TYPE_INVALID type: string - const: DPP_GRANULARITY_INVALID type: string - const: DPP_TIMESTAMP_INVALID type: string - const: DPP_RESERVED_NAME_CONFLICT type: string - const: DPP_ELEMENT_PATH_COLLISION type: string - const: DPP_COLLECTION_EMPTY type: string - const: DPP_ARRAY_TYPES_MIXED type: string path: type: array items: type: string fieldKeys: type: array items: type: string sectionKey: type: string fieldLabels: type: array items: type: object properties: key: type: string i18nId: type: string fallback: type: string required: - key required: - code - path - fieldKeys required: - errorCode - statusCode - success content: type: 'null' messages: type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: BATTERY_DPP_VALIDATION_FAILED statusCode: 400 success: false content: null messages: - messages '409': description: The schema version is inconsistent with the preserved definitions. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 409 errorCode: 0 messages: - The request conflicts with the current resource state. content: null security: [] summary: Read current active Battery DPP by unique product identifier. tags: - Product Passports /v1/dppsByProductIds: post: description: >- Returns matching public digital product passport ID strings for a page of input product identifiers. Unmatched products contribute no items. Follow nextCursor even when items is empty; pagination advances through the input products. operationId: CertificateDppController_readIdsByUniqueProductIdentifiers parameters: - name: cursor required: false in: query schema: type: string description: Cursor value used by this operation. example: cursor - name: limit required: false in: query schema: type: integer minimum: 1 maximum: 500 description: Maximum number of results to return. example: 1 requestBody: required: true content: application/json: schema: type: object properties: productIds: minItems: 1 maxItems: 500 type: array items: minLength: 1 type: string required: - productIds example: productIds: - product-ids description: >- Request payload for Read Battery DPP IDs by unique product identifiers. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: items: type: array items: type: string nextCursor: type: string required: - items required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: items: - items security: [] summary: Read Battery DPP IDs by unique product identifiers. tags: - Product Passports /v1/dppsByIdAndDate/{dppId}: get: description: >- Returns the public Battery DPP version effective at the requested date. An HTML request is redirected to the passport's public URL. operationId: CertificateDppController_readVersionByDigitalProductPassportIdAndDate parameters: - name: dppId required: true in: path schema: type: string description: Dpp identifier. example: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f - name: date required: true in: query schema: minLength: 1 type: string description: Date value used by this operation. example: date - name: representation required: false in: query schema: anyOf: - const: compressed type: string - const: full type: string description: Representation value used by this operation. example: compressed responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - additionalProperties: true type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - additionalProperties: false type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string elements: type: array items: anyOf: - type: object properties: elementId: type: string objectType: const: DataElementCollection type: string elements: minItems: 1 type: array items: $ref: >- #/paths/~1v1~1dppsByIdAndDate~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - elements - type: object properties: elementId: type: string objectType: const: SingleValuedDataElement type: string valueDataType: type: string value: anyOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: >- #/paths/~1v1~1dppsByIdAndDate~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value - type: object patternProperties: ^(.*)$: $ref: >- #/paths/~1v1~1dppsByIdAndDate~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value required: - elementId - objectType - valueDataType - value - type: object properties: elementId: type: string objectType: const: MultiValuedDataElement type: string valueDataType: type: string value: type: array items: $ref: >- #/paths/~1v1~1dppsByIdAndDate~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - value - type: object properties: elementId: type: string objectType: const: RelatedResource type: string contentType: type: string url: type: string language: type: string resourceTitle: type: string required: - elementId - objectType - contentType - url required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - elements required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: digitalProductPassportId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f uniqueProductIdentifier: unique-product-identifier dppSchemaVersion: dpp-schema-version lastUpdated: '2026-08-25T12:00:00.000Z' text/html: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: anyOf: - additionalProperties: true type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - additionalProperties: false type: object properties: digitalProductPassportId: minLength: 1 pattern: \S type: string uniqueProductIdentifier: minLength: 1 pattern: \S type: string granularity: anyOf: - const: model type: string - const: batch type: string - const: item type: string dppSchemaVersion: minLength: 1 pattern: \S type: string dppStatus: minLength: 1 pattern: \S type: string dppSchemaVerification: description: >- No original schema snapshot is available. This response uses the current template for legacy compatibility; its definitions are not verified against the schema used at publication. const: unverified type: string lastUpdated: format: date-time type: string economicOperatorId: minLength: 1 pattern: \S type: string facilityId: type: string contentSpecificationIds: type: array items: type: string elements: type: array items: anyOf: - type: object properties: elementId: type: string objectType: const: DataElementCollection type: string elements: minItems: 1 type: array items: $ref: >- #/paths/~1v1~1dppsByIdAndDate~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - elements - type: object properties: elementId: type: string objectType: const: SingleValuedDataElement type: string valueDataType: type: string value: anyOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: >- #/paths/~1v1~1dppsByIdAndDate~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value - type: object patternProperties: ^(.*)$: $ref: >- #/paths/~1v1~1dppsByIdAndDate~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items/anyOf/1/properties/value required: - elementId - objectType - valueDataType - value - type: object properties: elementId: type: string objectType: const: MultiValuedDataElement type: string valueDataType: type: string value: type: array items: $ref: >- #/paths/~1v1~1dppsByIdAndDate~1{dppId}/get/responses/200/content/application~1json/schema/properties/content/anyOf/1/properties/elements/items required: - elementId - objectType - value - type: object properties: elementId: type: string objectType: const: RelatedResource type: string contentType: type: string url: type: string language: type: string resourceTitle: type: string required: - elementId - objectType - contentType - url required: - digitalProductPassportId - uniqueProductIdentifier - dppSchemaVersion - lastUpdated - elements required: - _meta - messages - content example: _meta: success: true statusCode: 200 messages: - Success content: digitalProductPassportId: 4ac55d01-ec52-499e-9bc3-b5d648ffd88f uniqueProductIdentifier: unique-product-identifier dppSchemaVersion: dpp-schema-version lastUpdated: '2026-08-25T12:00:00.000Z' '400': description: >- Invalid battery DPP JSON header or structure; HTML navigation is unaffected. content: application/json: schema: type: object properties: _meta: type: object properties: errorCode: const: BATTERY_DPP_VALIDATION_FAILED type: string statusCode: const: 400 type: number success: const: false type: boolean validationIssues: type: array items: type: object properties: code: anyOf: - const: DPP_HEADER_REQUIRED type: string - const: DPP_HEADER_TYPE_INVALID type: string - const: DPP_GRANULARITY_INVALID type: string - const: DPP_TIMESTAMP_INVALID type: string - const: DPP_RESERVED_NAME_CONFLICT type: string - const: DPP_ELEMENT_PATH_COLLISION type: string - const: DPP_COLLECTION_EMPTY type: string - const: DPP_ARRAY_TYPES_MIXED type: string path: type: array items: type: string fieldKeys: type: array items: type: string sectionKey: type: string fieldLabels: type: array items: type: object properties: key: type: string i18nId: type: string fallback: type: string required: - key required: - code - path - fieldKeys required: - errorCode - statusCode - success content: type: 'null' messages: type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: BATTERY_DPP_VALIDATION_FAILED statusCode: 400 success: false content: null messages: - messages text/html: schema: type: object properties: _meta: type: object properties: errorCode: const: BATTERY_DPP_VALIDATION_FAILED type: string statusCode: const: 400 type: number success: const: false type: boolean validationIssues: type: array items: type: object properties: code: anyOf: - const: DPP_HEADER_REQUIRED type: string - const: DPP_HEADER_TYPE_INVALID type: string - const: DPP_GRANULARITY_INVALID type: string - const: DPP_TIMESTAMP_INVALID type: string - const: DPP_RESERVED_NAME_CONFLICT type: string - const: DPP_ELEMENT_PATH_COLLISION type: string - const: DPP_COLLECTION_EMPTY type: string - const: DPP_ARRAY_TYPES_MIXED type: string path: type: array items: type: string fieldKeys: type: array items: type: string sectionKey: type: string fieldLabels: type: array items: type: object properties: key: type: string i18nId: type: string fallback: type: string required: - key required: - code - path - fieldKeys required: - errorCode - statusCode - success content: type: 'null' messages: type: array items: type: string required: - _meta - content - messages example: _meta: errorCode: BATTERY_DPP_VALIDATION_FAILED statusCode: 400 success: false content: null messages: - messages '409': description: >- The preserved schema is invalid or inconsistent with the archived schema version. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 409 errorCode: 0 messages: - The request conflicts with the current resource state. content: null security: [] summary: Read Battery DPP version by digital product passport ID and date. tags: - Product Passports /v1/mcp: post: description: >- Sessionless Model Context Protocol endpoint for passport workflows. Authenticate with a platform API token whose entity has MCP_ACCESS and the feature for the requested passport type. Start with initialize, discover tools/resources/prompts, read minespider://guides/passport-domain, and use get_passport_schema for current fields. Tool calls can read or mutate real platform data; inspect the JSON-RPC result, structured tool outcome and warnings because HTTP 200 alone does not mean a tool succeeded. operationId: callMcp parameters: - name: Idempotency-Key in: header description: >- Alternative to a unique tools/call params._meta['minespider/idempotency-key'] value for each write. If both are supplied they must agree. Reusing the same key with the same authorized tool and arguments replays the original structured result and returns Idempotency-Replayed: true. Conflicts, in-progress requests and unresolved external effects are reported inside the JSON-RPC tool result; reconcile unknown outcomes before retrying. required: false schema: type: string example: passport-write-7dfc1e2c example: passport-write-7dfc1e2c requestBody: required: true description: >- One MCP Streamable HTTP JSON-RPC 2.0 request. Discover the deployed tools, resources and prompts instead of relying on a copied capability or passport-field list. JSON-RPC batch arrays are not supported. content: application/json: schema: type: object required: - jsonrpc - method additionalProperties: false properties: jsonrpc: type: string const: '2.0' id: description: >- Required for requests that expect a response; omitted for protocol notifications. oneOf: - type: string - type: number - type: 'null' method: type: string description: MCP protocol method. params: type: object additionalProperties: true examples: initialize: summary: Negotiate the MCP protocol value: jsonrpc: '2.0' id: 1 method: initialize params: protocolVersion: '2025-11-25' capabilities: {} clientInfo: name: customer-agent version: 1.0.0 discoverTools: summary: Discover current tools and their schemas value: jsonrpc: '2.0' id: 2 method: tools/list params: {} readDomainGuide: summary: Read the server-owned passport domain guide value: jsonrpc: '2.0' id: 3 method: resources/read params: uri: minespider://guides/passport-domain callTool: summary: Call a discovered tool value: jsonrpc: '2.0' id: 4 method: tools/call params: name: get_passport_schema arguments: type: product-passport writeWithPerCallKey: summary: Create a draft with a per-call idempotency key value: jsonrpc: '2.0' id: 5 method: tools/call params: name: create_passport_draft arguments: type: product-passport metadata: [] _meta: minespider/idempotency-key: draft-creation-7dfc1e2c responses: '200': description: >- JSON-RPC result or protocol error. Tool results include a structured outcome of completed, failed or unknown; inspect isError and structuredContent rather than relying on HTTP status alone. content: application/json: schema: oneOf: - type: object required: - jsonrpc - id - result additionalProperties: false properties: jsonrpc: type: string const: '2.0' id: oneOf: - type: string - type: number - type: 'null' result: type: object additionalProperties: true - type: object required: - jsonrpc - id - error additionalProperties: false properties: jsonrpc: type: string const: '2.0' id: oneOf: - type: string - type: number - type: 'null' error: type: object required: - code - message properties: code: type: integer message: type: string data: {} examples: initialized: summary: Successful protocol initialization value: jsonrpc: '2.0' id: 1 result: protocolVersion: '2025-11-25' capabilities: tools: {} resources: {} prompts: {} serverInfo: name: minespider version: 1.1.0 protocolError: summary: JSON-RPC protocol error value: jsonrpc: '2.0' id: 2 error: code: -32601 message: Method not found '202': description: >- Protocol notification accepted; no JSON-RPC response body is returned. '400': description: >- Malformed JSON, invalid top-level protocol request or unsupported JSON-RPC batch array. content: application/json: schema: type: object additionalProperties: true properties: error: type: object additionalProperties: true properties: code: oneOf: - type: string - type: integer message: type: string examples: batchRejected: summary: JSON-RPC batch arrays are not supported value: jsonrpc: '2.0' id: null error: code: -32600 message: MCP batch requests are not supported '401': description: Missing, invalid or non-API-token bearer credential. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: The authenticated entity does not have MCP_ACCESS. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '413': description: Request body exceeds the 64 KiB MCP limit. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 413 errorCode: 0 messages: - HTTP 413 error. content: null '429': description: Per-entity or per-IP MCP rate limit exceeded. headers: Retry-After: description: Seconds until another request may be attempted. schema: type: integer content: application/json: schema: type: object additionalProperties: true properties: error: type: object additionalProperties: true properties: code: oneOf: - type: string - type: integer message: type: string example: error: code: rate_limited retryAfterSeconds: 60 security: - bearer: [] summary: Execute an MCP Streamable HTTP request. tags: - MCP x-api-token-only: true /v1/regulatory-updates: get: description: >- Returns only manifest-complete daily briefings. Defaults to the last 30 calendar days in Europe/Lisbon. Custom inclusive ranges may span at most 31 days. operationId: RegulatoryUpdatesController_list parameters: - name: from required: false in: query schema: pattern: ^\d{4}-\d{2}-\d{2}$ type: string description: From value used by this operation. - name: to required: false in: query schema: pattern: ^\d{4}-\d{2}-\d{2}$ type: string description: To value used by this operation. responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: from: pattern: ^\d{4}-\d{2}-\d{2}$ type: string to: pattern: ^\d{4}-\d{2}-\d{2}$ type: string items: type: array items: type: object properties: reportDate: pattern: ^\d{4}-\d{2}-\d{2}$ type: string generatedAt: type: string evidenceCutoff: type: string executiveSummary: type: string noMaterialNewDevelopments: type: boolean counts: type: object properties: newDevelopments: minimum: 0 type: integer changedDevelopments: minimum: 0 type: integer upcoming: minimum: 0 type: integer reminders: minimum: 0 type: integer required: - newDevelopments - changedDevelopments - upcoming - reminders required: - reportDate - generatedAt - evidenceCutoff - executiveSummary - noMaterialNewDevelopments - counts required: - from - to - items required: - _meta - messages - content '400': description: The date range is invalid or longer than 31 days. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: The current entity does not have regulatory updates enabled. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: >- The feature is globally hidden or no published report exists for the date. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '502': description: A published report artifact failed validation. '503': description: The report storage is unavailable or not configured. security: - bearer: [] - cookie: [] summary: List published Reggie regulatory briefings. tags: - Regulatory Updates /v1/regulatory-updates/{date}/pdf: get: description: >- Reads a verified PDF from private storage after session, feature, date and manifest validation. operationId: RegulatoryUpdatesController_pdf parameters: - name: date required: true in: path description: Briefing calendar date (YYYY-MM-DD). schema: example: '2026-09-24' type: string example: '2026-09-24' responses: '200': description: Verified briefing PDF. content: application/pdf: schema: type: string format: binary '400': description: The date is not a valid YYYY-MM-DD calendar date. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: The current entity does not have regulatory updates enabled. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: >- The feature is globally hidden or no published report exists for the date. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '502': description: A published report artifact failed validation. '503': description: The report storage is unavailable or not configured. security: - bearer: [] - cookie: [] summary: Download a published Reggie regulatory briefing PDF. tags: - Regulatory Updates /v1/regulatory-updates/{date}: get: description: >- Returns the validated structured report and manifest generation time for a published calendar date. operationId: RegulatoryUpdatesController_detail parameters: - name: date required: true in: path description: Briefing calendar date (YYYY-MM-DD). schema: example: '2026-09-24' type: string example: '2026-09-24' responses: '200': description: Successful response. content: application/json: schema: type: object properties: _meta: type: object properties: success: example: true type: boolean statusCode: example: 200 type: integer total: description: Total matching records before pagination. type: number required: - success - statusCode messages: type: array items: example: Success type: string content: type: object properties: generatedAt: type: string report: additionalProperties: false type: object properties: schema: const: monitor_report.v1 type: string reportDate: pattern: ^\d{4}-\d{2}-\d{2}$ type: string evidenceCutoff: minLength: 10 maxLength: 80 type: string executiveSummary: minLength: 1 maxLength: 6000 type: string noMaterialNewDevelopments: type: boolean newDevelopments: maxItems: 30 type: array items: additionalProperties: false type: object properties: key: minLength: 3 maxLength: 240 pattern: ^[a-z0-9][a-z0-9._:-]*$ type: string title: minLength: 1 maxLength: 500 type: string jurisdiction: minLength: 1 maxLength: 160 type: string topic: minLength: 1 maxLength: 240 type: string eventType: minLength: 1 maxLength: 160 type: string status: anyOf: - const: confirmed type: string - const: reported type: string - const: watch type: string summary: minLength: 1 maxLength: 4000 type: string whyItMatters: minLength: 1 maxLength: 2000 type: string relevantDate: anyOf: - minLength: 1 maxLength: 160 type: string - type: 'null' sources: minItems: 1 maxItems: 12 type: array items: additionalProperties: false type: object properties: title: minLength: 1 maxLength: 500 type: string publisher: minLength: 1 maxLength: 300 type: string url: minLength: 1 maxLength: 4096 type: string publishedAt: anyOf: - minLength: 1 maxLength: 80 type: string - type: 'null' isPrimary: type: boolean required: - title - publisher - url - publishedAt - isPrimary required: - key - title - jurisdiction - topic - eventType - status - summary - whyItMatters - relevantDate - sources changedDevelopments: maxItems: 30 type: array items: additionalProperties: false type: object properties: key: minLength: 3 maxLength: 240 pattern: ^[a-z0-9][a-z0-9._:-]*$ type: string title: minLength: 1 maxLength: 500 type: string jurisdiction: minLength: 1 maxLength: 160 type: string topic: minLength: 1 maxLength: 240 type: string eventType: minLength: 1 maxLength: 160 type: string status: anyOf: - const: confirmed type: string - const: reported type: string - const: watch type: string summary: minLength: 1 maxLength: 4000 type: string whyItMatters: minLength: 1 maxLength: 2000 type: string relevantDate: anyOf: - minLength: 1 maxLength: 160 type: string - type: 'null' sources: minItems: 1 maxItems: 12 type: array items: additionalProperties: false type: object properties: title: minLength: 1 maxLength: 500 type: string publisher: minLength: 1 maxLength: 300 type: string url: minLength: 1 maxLength: 4096 type: string publishedAt: anyOf: - minLength: 1 maxLength: 80 type: string - type: 'null' isPrimary: type: boolean required: - title - publisher - url - publishedAt - isPrimary required: - key - title - jurisdiction - topic - eventType - status - summary - whyItMatters - relevantDate - sources upcoming: maxItems: 30 type: array items: additionalProperties: false type: object properties: key: minLength: 3 maxLength: 240 pattern: ^[a-z0-9][a-z0-9._:-]*$ type: string title: minLength: 1 maxLength: 500 type: string jurisdiction: minLength: 1 maxLength: 160 type: string topic: minLength: 1 maxLength: 240 type: string eventType: minLength: 1 maxLength: 160 type: string status: anyOf: - const: confirmed type: string - const: reported type: string - const: watch type: string summary: minLength: 1 maxLength: 4000 type: string whyItMatters: minLength: 1 maxLength: 2000 type: string relevantDate: anyOf: - minLength: 1 maxLength: 160 type: string - type: 'null' sources: minItems: 1 maxItems: 12 type: array items: additionalProperties: false type: object properties: title: minLength: 1 maxLength: 500 type: string publisher: minLength: 1 maxLength: 300 type: string url: minLength: 1 maxLength: 4096 type: string publishedAt: anyOf: - minLength: 1 maxLength: 80 type: string - type: 'null' isPrimary: type: boolean required: - title - publisher - url - publishedAt - isPrimary required: - key - title - jurisdiction - topic - eventType - status - summary - whyItMatters - relevantDate - sources reminders: maxItems: 20 type: array items: additionalProperties: false type: object properties: key: minLength: 3 maxLength: 240 pattern: ^[a-z0-9][a-z0-9._:-]*$ type: string title: minLength: 1 maxLength: 500 type: string jurisdiction: minLength: 1 maxLength: 160 type: string topic: minLength: 1 maxLength: 240 type: string eventType: minLength: 1 maxLength: 160 type: string status: anyOf: - const: confirmed type: string - const: reported type: string - const: watch type: string summary: minLength: 1 maxLength: 4000 type: string whyItMatters: minLength: 1 maxLength: 2000 type: string relevantDate: anyOf: - minLength: 1 maxLength: 160 type: string - type: 'null' sources: minItems: 1 maxItems: 12 type: array items: additionalProperties: false type: object properties: title: minLength: 1 maxLength: 500 type: string publisher: minLength: 1 maxLength: 300 type: string url: minLength: 1 maxLength: 4096 type: string publishedAt: anyOf: - minLength: 1 maxLength: 80 type: string - type: 'null' isPrimary: type: boolean required: - title - publisher - url - publishedAt - isPrimary required: - key - title - jurisdiction - topic - eventType - status - summary - whyItMatters - relevantDate - sources sourcesChecked: minItems: 1 maxItems: 100 type: array items: additionalProperties: false type: object properties: title: minLength: 1 maxLength: 500 type: string publisher: minLength: 1 maxLength: 300 type: string url: minLength: 1 maxLength: 4096 type: string publishedAt: anyOf: - minLength: 1 maxLength: 80 type: string - type: 'null' isPrimary: type: boolean required: - title - publisher - url - publishedAt - isPrimary required: - schema - reportDate - evidenceCutoff - executiveSummary - noMaterialNewDevelopments - newDevelopments - changedDevelopments - upcoming - reminders - sourcesChecked required: - generatedAt - report required: - _meta - messages - content '400': description: The date is not a valid YYYY-MM-DD calendar date. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 400 errorCode: '6728' messages: - The request is invalid. content: null '401': description: Authentication is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 401 errorCode: '2283' messages: - >- You are not allowed to proceed with the request. Please provide your credentials. content: null '403': description: The current entity does not have regulatory updates enabled. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 403 errorCode: '5856' messages: - You are not allowed to perform this action content: null '404': description: >- The feature is globally hidden or no published report exists for the date. content: application/json: schema: $ref: '#/components/schemas/MinespiderErrorResponse' example: _meta: success: false statusCode: 404 errorCode: '4448' messages: - The requested resource was not found. content: null '502': description: A published report artifact failed validation. '503': description: The report storage is unavailable or not configured. security: - bearer: [] - cookie: [] summary: Read one published Reggie regulatory briefing. tags: - Regulatory Updates info: title: Minespider QA API description: > # Welcome to Minespider Platform API ## About Minespider Minespider is a supply-chain traceability platform focused on battery passports. We help companies document the origin, composition and lifecycle of batteries, connect supporting evidence, and share information with authorised partners. Our platform grew out of raw-material traceability and also supports digital product passports for other industries. Visit [minespider.com](https://www.minespider.com) to learn more, or [contact our team](https://www.minespider.com/contact-us) for a demonstration. ## About the Platform The Minespider REST API connects your systems to the platform. Use it to create and manage passports, attach documents, organise supply-chain information, and control access to shared data. The Product Passports section covers battery passports and other passport types. Existing paths and fields often use `certificate` for a passport; use the identifiers shown in the reference. ## Roles and what they can do An entity is an organisation. The API supports two organisation roles: - **Entity Administrator:** manages members, settings and administrative operations. - **Entity Member:** works with passports and data according to their permissions. Tenant integrations act on behalf of organisations that grant them access, supporting use cases such as marketplaces and exchanges. Tenancy is an integration model, not another member role. Tenant integrations use [Tenancy Access](#tag/Tenancy-Access); external data requesters use their [restricted session](#tag/External-Data-Requests-Requester). Check the access requirements of each operation. ## Get started **Base URL:** `https://api.minespider.com`. For another deployment, use its API host. Use a valid API token for your user and organisation. See [API Tokens](#tag/API-Tokens) for token management. ```sh curl https://api.minespider.com/v1/entity/me \ --header "Authorization: Bearer $MINESPIDER_API_TOKEN" ``` HTTP 200 returns the current user profile. HTTP 401 means authentication failed. This request does not create or change a passport. [OpenAPI JSON](/docs/json) · [OpenAPI YAML](/docs/yaml) Most JSON responses use `content` for the result, `_meta` for metadata and `messages` for messages. Downloads and webhook events use other formats. Each operation documents its parameters, response schema and error statuses. version: 3.43.0 contact: {} x-logo: url: https://assets.minespider.com/img/ms-brand-hor-black.svg tags: - name: Webhooks description: "Receive an HTTPS notification when a supported asynchronous passport operation finishes. Webhooks must be enabled for your deployment and organisation.\n\n### Register a receiver\n\nUse an entity administrator's native credentials for entity subscriptions, or a tenant secret for tenant subscriptions. Impersonated and external user tokens cannot manage subscriptions. Tenant subscriptions cover all enabled organisations to which the tenant has active access.\n\nCreate a subscription with your HTTPS endpoint and selected event types. Save the full signing secret returned by creation or rotation; list and update responses do not include it. Redirects and custom authorisation headers are not supported.\n\n### Read the event\n\nDeliveries contain a raw event object, without the API response envelope. Use `operation` and `schemaVersion` to interpret it. A completed job can contain failed items; inspect `outcomes`.\n\n```json\n{\n\t\"eventId\": \"df96a8b7-f40c-469d-8e98-5b3edf2b04dc\",\n\t\"schemaVersion\": \"1.0\",\n\t\"occurredAt\": \"2026-10-22T10:00:00.000Z\",\n\t\"operation\": \"certificate.import\",\n\t\"job\": { \"queue\": \"certificate-import\", \"id\": \"62\" },\n\t\"ownerEntityId\": \"751c2c52-3ba2-47d7-ad56-508cd76d5c01\",\n\t\"terminalStatus\": \"completed\",\n\t\"outcomes\": {\n\t\t\"succeeded\": [{ \"certificateId\": \"71d00d9e-466a-4d36-adb8-d232553702fd\", \"index\": 0 }],\n\t\t\"failed\": [{ \"index\": 1, \"code\": \"CERTIFICATE_INPUT_INVALID\", \"message\": \"Invalid material\" }]\n\t}\n}\n```\n\nEvent identifiers start with `com.minespider.` and end with `.completed.v1`, even when `terminalStatus` is `failed`.\n\n| Operation | Successful item | Failed item |\n| ------------------------------ | ------------------------------------------------------ | ---------------------------------------------- |\n| `certificate.import` | `{certificateId, index}` | `{index, code, message}` |\n| `certificate.batch.publish` | `{certificateId}` | `{certificateId, code, message}` |\n| `certificate.batch.deprecate` | `{certificateId}` | `{certificateId, code, message}` |\n| `certificate.batch.duplicate` | `{certificateId}` of the copy | `{certificateId, code, message}` of the source |\n| `certificate.batch.patch` | `{certificateId, patchedCertificateId, index, cloned}` | `{certificateId, index, code, message}` |\n| `certificate.acl.batch.grant` | `{certificateId}` | `{certificateId, code, message}` |\n| `certificate.acl.batch.revoke` | `{certificateId}` | `{certificateId, index, code, message}` |\n\n`index` is the zero-based position in the job input, not a spreadsheet row or result-array position. Historical import results can omit it. Missing identifiers are omitted. `initiatingMemberId` and `correlationId` are optional. `occurredAt` is an ISO UTC timestamp; delivery-history timestamps are Unix milliseconds.\n\nBoth outcome arrays are always present. Job-level failure has no successful items and includes known input identifiers in failures. Error codes can vary; unexpected failures use `INTERNAL_ERROR`. Batch creation, standard export and batch deletion do not emit these events.\n\n### Verify before processing\n\nRead `X-Minespider-Webhook-Timestamp` (Unix seconds) and `X-Minespider-Webhook-Signature`. Compute HMAC-SHA256 over the UTF-8 timestamp, a literal dot and the exact raw body bytes, using the full secret (including `whsec_`) as UTF-8. Do not base64-decode the secret or parse and reserialize the body. Compare with `v1=<64 lowercase hex characters>` in constant time.\n\nReject malformed or repeated headers and timestamps outside your replay tolerance (five minutes recommended). Keep clocks synchronised. Match `X-Minespider-Webhook-Id` to the signed body's `eventId`.\n\n### Acknowledge and handle retries\n\nDurably accept the event, then return 2xx within 10 seconds. Other responses, timeouts and transport failures are retried for up to seven days; `Retry-After` does not change the schedule. Duplicates and out-of-order delivery are possible. Deduplicate by `eventId` for at least that window, and acknowledge accepted duplicates without repeating their effects.\n\nRetries keep the event body and ID but use a fresh timestamp and the current secret. Changing the receiver URL redirects subsequent attempts of pending deliveries. Secret rotation invalidates the old secret immediately; an in-flight request can still carry the old signature. Coordinate receiver updates.\n\nDisabling a subscription or losing access cancels pending deliveries. Reactivation and new subscriptions do not replay past events. Use delivery history and the authorised job-status endpoint for the originating operation to investigate missing outcomes; both are retained for seven days.\n\nUse an `Idempotency-Key` when creating, updating or rotating a subscription, and reuse it with the same request when retrying. Without a key, repeating creation or rotation can create another subscription or replace the secret again. See the endpoint header documentation for conflict and replay rules. The secret cannot be recovered by listing subscriptions.\n" - name: Tenant Webhooks description: >- Manage subscriptions using your tenant secret. See [Webhooks](#tag/Webhooks) for event payloads, signature verification and delivery rules. - name: Feature Flags description: >- Platform administrators only. Manage feature availability across organisations. - name: Entity Limits description: Platform administrators only. Manage organisation usage limits. - name: Entity Control Batch description: Platform administrators only. Apply organisation controls in bulk. - name: Independent DPP Backup description: >- Organisation administrators can check backups and manage recovery tokens. Delivery operations and cross-organisation status require a platform administrator. Issuing recovery tokens and checking organisation backup status require the DPP_BACKUP feature. - name: External Data Requests description: >- Public entry points for requesting passport data. Exchanging an access link requires its valid one-time token. - name: External Data Requests - Requester description: Requires the restricted session established by exchanging an access link. - name: External Data Requests - Admin description: >- Requires an organisation administrator and the external data request feature. - name: Catena-X description: >- Requires the Catena-X integration to be enabled. Check each operation for its credentials, permissions and availability. servers: - url: https://api.qa.minespider.com components: securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http cookie: type: apiKey in: cookie name: qa.session mfaChallenge: type: apiKey in: cookie name: qa.session.mfa.challenge mfaBinding: type: apiKey in: cookie name: qa.session.mfa.binding external_data_request_session: type: apiKey in: cookie name: external_data_request_session schemas: MinespiderErrorResponse: type: object additionalProperties: false description: Standard Minespider error response envelope. properties: _meta: type: object additionalProperties: false properties: success: type: boolean const: false example: false statusCode: type: integer description: HTTP response status. example: 400 errorCode: anyOf: - type: string - type: integer description: Stable application error code, or 0 for framework errors. example: '6728' required: - success - statusCode - errorCode messages: type: array description: Human-readable error details. items: type: string example: - The request is invalid. content: type: 'null' description: Error responses do not contain result content. required: - _meta - messages - content x-tagGroups: - name: Authentication tags: - API Tokens - Authentication - name: Entity Management tags: - Invitations - Entities - Members - Entity Types - Tabs - Entity Settings - Notifications - name: User Management tags: - Users - name: Product Passports tags: - Supply Chain Analytics - Passport Attachments - Product Passports - Passport Labels - Passport Links - Certificate Public Links - Passport Events - Passport Attention - Passport Tags - Passport Materials - Passport Disqualifications - Labels - Tags - Passports ACL - Materials - Material Types - Measurement Units - Measurement Types - Passport Metadata - MCP - name: Storage and Recovery tags: - File Storage - Independent DPP Backup - name: Tenancy tags: - Tenancy Access - Tenants - Tenant Members - Tenant Entities - name: Template tags: - Template Analytics - Template Requests - Template Properties - Template Standards - Templates - name: Blockchain tags: - File Store - name: Webhooks tags: - Webhooks - Tenant Webhooks - name: External Data Requests tags: - External Data Requests - External Data Requests - Requester - External Data Requests - Admin - name: Integrations tags: - Catena-X - name: Updates and Audit tags: - Regulatory Updates - Logs - name: Platform Administration tags: - Feature Flags - Entity Limits - Entity Control Batch - name: System tags: - Healthcheck