json icon

Partner Updated

v1.0.0events

The personal data of a franchise partner changed in CNA Nexus - name, legal name, e-mail, phone or birth date. Snapshot of the person, keyed by the person id. To be published by cna-nexus and consumed by cna-one; neither side has the class yet.

1{
2  "$schema": "https://json-schema.org/draft/2020-12/schema",
3  "title": "PartnerUpdated payload",
4  "type": "object",
5  "additionalProperties": false,
6  "properties": {
7    "id": {
8      "type": "string",
9      "description": "Person id (UUID) in common.persons. Kafka message key. Same value as person.id in the FranchisePartner events."
10    },
11    "document": {
12      "type": "string",
13      "description": "Person document; format depends on documentType. The key cna-one correlates the person by."
14    },
15    "documentType": {
16      "type": "string",
17      "enum": ["CPF", "CNPJ", "RNM"],
18      "description": "Document type (PersonsDocumentType)."
19    },
20    "name": {
21      "type": "string",
22      "description": "Person name."
23    },
24    "legalName": {
25      "type": ["string", "null"],
26      "description": "Legal name, for companies."
27    },
28    "email": {
29      "type": ["string", "null"],
30      "description": "E-mail, or null."
31    },
32    "phone": {
33      "type": ["string", "null"],
34      "description": "Phone, or null."
35    },
36    "birthDate": {
37      "type": ["string", "null"],
38      "format": "date",
39      "description": "Birth date as a calendar day, YYYY-MM-DD, no time zone. Null when unknown."
40    }
41  },
42  "required": ["id", "document", "documentType", "name"]
43}
44

Details

Format
JSON Schema
Resource
events
Filename
schema.json

Versions