Identification changed [beta]

This event occurs when an identification changes.

Type: object
Domain: entity
Event: identification_change
Version: 1

identification_id required

Title: Identification ID
Description: Unique numeric identification ID.
Type: integer

entity_id

Title: Entity ID
Description: Unique numeric entity ID.
Type: integer

old_identification required

Title: Old identification object
Description: Object with old identification information
Type: object

type

Description: Identification type.
Type: string
Max length: 50

value

Description: Identification value.
Type: string
Max length: 100

country

Description: Identification country.
Type: string or null
Max length: 30

issuer

Description: Identification issuer.
Type: string or null
Max length: 30

issued_date

Description: Identification issued date.
Type: string or null
Format: date
Example:
2023-01-31

expire_date

Description: Identification expiration date.
Type: string or null
Format: date
Example:
2023-01-31

new_identification required

Title: New identification object
Description: Object with new identification information
Type: object

type

Description: Identification type.
Type: string
Max length: 50

value

Description: Identification value.
Type: string
Max length: 100

country

Description: Identification country.
Type: string or null
Max length: 30

issuer

Description: Identification issuer.
Type: string or null
Max length: 30

issued_date

Description: Identification issued date.
Type: string or null
Format: date
Example:
2023-01-31

expire_date

Description: Identification expiration date.
Type: string or null
Format: date
Example:
2023-01-31

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://example.com/root.json",
    "type": "object",
    "title": "Identification changed [beta]",
    "description": "This event occurs when an identification changes.",
    "required": [
        "identification_id",
        "old_identification",
        "new_identification"
    ],
    "properties": {
        "identification_id": {
            "type": "integer",
            "title": "Identification ID",
            "description": "Unique numeric identification ID."
        },
        "entity_id": {
            "type": "integer",
            "title": "Entity ID",
            "description": "Unique numeric entity ID."
        },
        "old_identification": {
            "type": "object",
            "title": "Old identification object",
            "description": "Object with old identification information",
            "properties": {
                "type": {
                    "type": "string",
                    "description": "Identification type.",
                    "maxLength": 50
                },
                "value": {
                    "type": "string",
                    "description": "Identification value.",
                    "maxLength": 100
                },
                "country": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Identification country.",
                    "maxLength": 30
                },
                "issuer": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Identification issuer.",
                    "maxLength": 30
                },
                "issued_date": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Identification issued date.",
                    "format": "date",
                    "examples": [
                        "2023-01-31"
                    ]
                },
                "expire_date": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Identification expiration date.",
                    "format": "date",
                    "examples": [
                        "2023-01-31"
                    ]
                }
            }
        },
        "new_identification": {
            "type": "object",
            "title": "New identification object",
            "description": "Object with new identification information",
            "properties": {
                "type": {
                    "type": "string",
                    "description": "Identification type.",
                    "maxLength": 50
                },
                "value": {
                    "type": "string",
                    "description": "Identification value.",
                    "maxLength": 100
                },
                "country": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Identification country.",
                    "maxLength": 30
                },
                "issuer": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Identification issuer.",
                    "maxLength": 30
                },
                "issued_date": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Identification issued date.",
                    "format": "date",
                    "examples": [
                        "2023-01-31"
                    ]
                },
                "expire_date": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Identification expiration date.",
                    "format": "date",
                    "examples": [
                        "2023-01-31"
                    ]
                }
            }
        }
    }
}

Updated about 2 months ago