Customer application created
This event occurs when the platform creates a customer during a migration.
Type: object
Domain: onboarding
Event: customer_succeeded
Version: 1
entity
Type: object
id required
Title: Entity ID
Description: Pismo entity ID.
Type: integer
Example:
100428899name
Title: Cardholder name
Description: Cardholder name
Type: string or null
Max length: 60
Example:
Kris Smithdocument_number required
Title: Document number
Description: Document number of the entity.
Type: string
Max length: 15
Example:
74086002051registration
Title: Entity registration
Description: Registration number for another document to identify the entity.
Type: string or null
Max length: 15
Example:
123456birth_date
Title: Birth date
Description: Entity's birth date.
Type: string or null
Example:
1991-01-30gender
Title: Entity gender
Description: Entity's gender. If exists, it is validated as 'F' or 'M'.
Type: string or null
Example:
F
Mmarital_status
Title: Marital status
Description: Martital status of the entity.
Type: string or null
Max length: 30
Example:
SINGLE
MARRIED
DIVORCED
WIDOWERmothers_name
Title: Mother's name
Description: Mother's name of the entity.
Type: string or null
Max length: 60
Example:
Mary Smith
customer
Type: object
id required
Title: Customer ID
Description: Pismo customer ID.
Type: integer
Example:
100602614social_name
Title: Social name
Description: Customer's social name.
Type: string or null
Max length: 64
Example:
MariaTitle: Email
Description: Customer's email.
Type: string or null
Max length: 255
Example:
[email protected]is_active
Title: Active flag
Description: Flag that indicates whether the customer is active.
Type: boolean
Example:
false
true
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"title": "Customer application created",
"description": "This event occurs when the platform creates a customer during a migration.",
"required": [],
"properties": {
"entity": {
"type": "object",
"required": [
"id",
"document_number"
],
"properties": {
"id": {
"type": "integer",
"title": "Entity ID",
"description": "Pismo entity ID.",
"examples": [
100428899
]
},
"name": {
"type": [
"string",
"null"
],
"title": "Cardholder name",
"description": "Cardholder name",
"maxLength": 60,
"examples": [
"Kris Smith"
]
},
"document_number": {
"type": "string",
"title": "Document number",
"description": "Document number of the entity.",
"maxLength": 15,
"examples": [
"74086002051"
]
},
"registration": {
"type": [
"string",
"null"
],
"title": "Entity registration",
"description": "Registration number for another document to identify the entity.",
"maxLength": 15,
"examples": [
"123456"
]
},
"birth_date": {
"type": [
"string",
"null"
],
"title": "Birth date",
"description": "Entity's birth date.",
"examples": [
"1991-01-30"
]
},
"gender": {
"type": [
"string",
"null"
],
"title": "Entity gender",
"description": "Entity's gender. If exists, it is validated as 'F' or 'M'.",
"examples": [
"F",
"M"
]
},
"marital_status": {
"type": [
"string",
"null"
],
"title": "Marital status",
"description": "Martital status of the entity.",
"maxLength": 30,
"examples": [
"SINGLE",
"MARRIED",
"DIVORCED",
"WIDOWER"
]
},
"mothers_name": {
"type": [
"string",
"null"
],
"title": "Mother's name",
"description": "Mother's name of the entity.",
"maxLength": 60,
"examples": [
"Mary Smith"
]
}
}
},
"customer": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"title": "Customer ID",
"description": "Pismo customer ID.",
"examples": [
100602614
]
},
"social_name": {
"type": [
"string",
"null"
],
"title": "Social name",
"description": "Customer's social name.",
"maxLength": 64,
"examples": [
"Maria"
]
},
"email": {
"type": [
"string",
"null"
],
"title": "Email",
"description": "Customer's email.",
"maxLength": 255,
"examples": [
"[email protected]"
]
},
"is_active": {
"type": "boolean",
"title": "Active flag",
"description": "Flag that indicates whether the customer is active.",
"examples": [
false,
true
]
}
}
}
}
}
{
"entity": {
"id": 100428899,
"name": "Kris Smith",
"document_number": "74086002051",
"registration": "123456",
"birth_date": "1991-01-30",
"gender": "F",
"marital_status": "SINGLE",
"mothers_name": "Mary Smith"
},
"customer": {
"id": 100602614,
"social_name": "Maria",
"email": "[email protected]",
"is_active": false
}
}
Updated 7 days ago