Customer created
This event occurs when a new customer is created.
Generated by: Create customer
More information: Customer objects
Type: object
Domain: account
Event: customer_creation
Version: 1
entity required
Title: Entity object
Description: Object with the entity properties. Any person or company is registered uniquely in each Org and assigned an entity ID. This entity ID is required as an attribute for most end-client object creation, such as credit card or merchant accounts. Although not structurally necessary, whenever an entity is created in the platform, a name and a document string are always required as its minimum attributes.
Type: objectid required
Title: Entity ID
Description: Unique ID used to retrieve entity details in the Pismo platform APIs.
Type: integer
Example:
100428899name required
Title: Cardholder name
Description: Cardholder name
Type: string
Max length: 60
Example:
Kris Smithgender
Title: Entity gender
Description: Entity gender. If exists, it is validated as 'F' or 'M'.
Type: string or null
Example:
F
Mregistration
Title: Entity registration
Description: Registration of the entity. If exists, it is another document from the entity.
Type: string or null
Max length: 15
Example:
123456marital_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 Smithbirth_date
Title: Birth date
Description: Birth date of the entity.
Type: string or null
Example:
1991-01-01document_number required
Title: Document number
Description: Document number of the entity.
Type: string
Max length: 15
Example:
74086002051pep
Title: Political exposure
Description: Indicates if the entity is politically exposed.
Type: string or null
Example:
true
falseperson
Title: Person information object
Description: Object with the entity's person information.
Type: objectnationality
Title: Nationality
Description: Person's nationality.
Type: string or null
Max length: 60
Example:
Braziliancity_of_birth
Title: City of birth
Description: Person's city of birth.
Type: string or null
Max length: 60
Example:
São Paulostate_of_birth
Title: State of birth
Description: Person's state of birth.
Type: string or null
Max length: 60
Example:
São Paulocountry_of_birth
Title: Country of birth
Description: Person's country of birth.
Type: string or null
Max length: 60
Example:
Brazilother_id_number
Title: Other ID number
Description: Another document ID. For example, the number of an RG in Brazil, or a drive license.
Type: string or null
Max length: 30
Example:
12345667document_type
Title: Other ID ocument type
Description: Document type of the other ID number.
Type: string or null
Max length: 30
Example:
RGdocument_issued_by
Title: Other ID document issuer
Description: Document issues of the other ID number.
Type: string or null
Max length: 30
Example:
SSP
PCdocument_issued_at
Title: Document issued location
Description: Location where the document was issued.
Type: string or null
Max length: 30
Example:
SP
RJdocument_issued_date
Title: Document issued date
Description: Date when the document was issued.
Type: string or null
Example:
2000-01-01fathers_name
Title: Farther's name
Description: Father's name of the person.
Type: string or null
Max length: 60
Example:
John Smithoccupation
Title: Occupation
Description: Person's occupation.
Type: string or null
Max length: 60
Example:
Writerassets
Title: Assets
Description: Person's assets.
Type: number or null
Example:
10.0income
Title: Income
Description: Person's income.
Type: number or null
Example:
112312.12net_worth
Title: Net worth
Description: Person's net worth.
Type: number or null
Example:
112312.12company
Title: Company information object
Description: Object with the entity's company information.
Type: objectregistration_number
Title: Registration number
Description: Number under which the company is registered.
Type: string or null
Max length: 30
Example:
123456company_name
Title: Company name
Description: Company trading name.
Type: string or null
Max length: 60
Example:
Company nameactivity
Title: Activity
Description: Company activity.
Type: string or null
Max length: 30
Example:
Manufacturingcompany_type
Title: Company type
Description: Company type.
Type: string or null
Max length: 60
Example:
S.A
LTDAcompany_format
Title: Company format
Description: Company classification.
Type: string or null
Max length: 60
Example:
ME
MEIcompany_constitution_date
Title: Company consitution date
Description: Company's operational start date.
Type: string or null
Example:
2000-01-01occupation
Title: Occupation
Description: Company's main occupation.
Type: string or null
Max length: 60
Example:
Online Retailannual_revenues
Title: Annual revenue
Description: Company's average monthly revenue for the last 12 months.
Type: number or null
Example:
10.0type
Title: Type
Description: Company's business relations type.
Type: string or null
Max length: 60
Example:
B2Cnumber_of_partners
Title: Number of partners
Description: Company's number of partners.
Type: integer or null
Example:
100perc_ownership
Title: Percentage of ownership
Description: Company's percentage of ownership.
Type: number or null
Example:
50fiscal_situation
Title: Fiscal situation
Description: Company's fiscal situation.
Type: string or null
Max length: 60
Example:
Maintenancedebt
Title: Debt amount
Description: Company's debt amount.
Type: number or null
Example:
18000income
Title: Income
Description: Company's income.
Type: number or null
Example:
112312.12net_worth
Title: Net worth
Description: Company's net worth.
Type: number or null
Example:
112312.12partners
Title: Partners
Description: This metadata object contains company's partner information, as specified in the client request at customer creation.
Type: array or null
customer required
Title: Customer object
Description: Object with the customer properties. Each account can be linked to an entity through a customer. Accounts can have an unlimited number of customers attached to them, but only one of these customers can have theisownerattribute set totrue. All other customers are automatically set to dependents with theisownerattribute set tofalse. The customer object controls attributes of an entity when associated with a given account. For example, the entity John Doe may have his office-issued phone number associated with his Visa corporate credit card customer and his private phone number associated with his private wallet customer. There are no parameters set at the customer level, but several account parameters use theisownerattribute to validate.
Type: objectid required
Title: Customer ID
Description: Unique ID associated with the Pismo customer. This field is used to retrieve customer details in the Pismo platform APIs.
Type: integer
Example:
100602614nickname
Title: Nickname
Description: Customer nickname.
Type: string or null
Max length: 128printed_name required
Title: Printed name
Description: Customer name printed on the card. In the case whereprinted_nameis not specified, the platform uses thesocial_nameornameto create theprinted_name.
Max length: 25
Example:
Maria M Silvasocial_name
Title: Social name
Description: Customer's social name.
Type: string or null
Max length: 64
Example:
Mariais_owner required
Title: Owner flag
Description: Flag that indicates if this customer is the owner of the account.
Type: boolean
Example:
true
falseTitle: Email
Description: Customer's email.
Type: string or null
Max length: 255
Example:
[email protected]
account_id required
Title: Account ID
Description: Unique ID associated with the Pismo account.
Type: integer
Example:
31700
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "http://example.com/example.json",
"type": "object",
"title": "Customer created",
"description": "This event occurs when a new customer is created. \n Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/customerv2post' target='_blank'>Create customer</a> \n More information: <a href='https://developers.pismo.io/pismo-docs/docs/working-with-customer-objects' target='_blank'>Customer objects</a>",
"required": [
"entity",
"customer",
"account_id"
],
"properties": {
"entity": {
"type": "object",
"title": "Entity object",
"description": "Object with the entity properties. Any person or company is registered uniquely in each Org and assigned an entity ID. This entity ID is required as an attribute for most end-client object creation, such as credit card or merchant accounts. Although not structurally necessary, whenever an entity is created in the platform, a name and a document string are always required as its minimum attributes.",
"required": [
"id",
"name",
"document_number"
],
"properties": {
"id": {
"type": "integer",
"title": "Entity ID",
"description": "Unique ID used to retrieve entity details in the Pismo platform APIs.",
"examples": [
100428899
]
},
"name": {
"type": "string",
"title": "Cardholder name",
"description": "Cardholder name",
"maxLength": 60,
"examples": [
"Kris Smith"
]
},
"gender": {
"type": [
"string",
"null"
],
"title": "Entity gender",
"description": "Entity gender. If exists, it is validated as 'F' or 'M'.",
"examples": [
"F",
"M"
]
},
"registration": {
"type": [
"string",
"null"
],
"title": "Entity registration",
"description": "Registration of the entity. If exists, it is another document from the entity.",
"maxLength": 15,
"examples": [
"123456"
]
},
"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"
]
},
"birth_date": {
"type": [
"string",
"null"
],
"title": "Birth date",
"description": "Birth date of the entity.",
"examples": [
"1991-01-01"
]
},
"document_number": {
"type": "string",
"title": "Document number",
"description": "Document number of the entity.",
"maxLength": 15,
"examples": [
"74086002051"
]
},
"pep": {
"type": [
"string",
"null"
],
"title": "Political exposure",
"description": "Indicates if the entity is politically exposed.",
"examples": [
"true",
"false"
]
},
"person": {
"type": "object",
"title": "Person information object",
"description": "Object with the entity's person information.",
"properties": {
"nationality": {
"type": [
"string",
"null"
],
"title": "Nationality",
"description": "Person's nationality.",
"maxLength": 60,
"examples": [
"Brazilian"
]
},
"city_of_birth": {
"type": [
"string",
"null"
],
"title": "City of birth",
"description": "Person's city of birth.",
"maxLength": 60,
"examples": [
"S\u00e3o Paulo"
]
},
"state_of_birth": {
"type": [
"string",
"null"
],
"title": "State of birth",
"description": "Person's state of birth.",
"maxLength": 60,
"examples": [
"S\u00e3o Paulo"
]
},
"country_of_birth": {
"type": [
"string",
"null"
],
"title": "Country of birth",
"description": "Person's country of birth.",
"maxLength": 60,
"examples": [
"Brazil"
]
},
"other_id_number": {
"type": [
"string",
"null"
],
"title": "Other ID number",
"description": "Another document ID. For example, the number of an RG in Brazil, or a drive license.",
"maxLength": 30,
"examples": [
"12345667"
]
},
"document_type": {
"type": [
"string",
"null"
],
"title": "Other ID ocument type",
"description": "Document type of the other ID number.",
"maxLength": 30,
"examples": [
"RG"
]
},
"document_issued_by": {
"type": [
"string",
"null"
],
"title": "Other ID document issuer",
"description": "Document issues of the other ID number.",
"maxLength": 30,
"examples": [
"SSP",
"PC"
]
},
"document_issued_at": {
"type": [
"string",
"null"
],
"title": "Document issued location",
"description": "Location where the document was issued.",
"maxLength": 30,
"examples": [
"SP",
"RJ"
]
},
"document_issued_date": {
"type": [
"string",
"null"
],
"title": "Document issued date",
"description": "Date when the document was issued.",
"examples": [
"2000-01-01"
]
},
"fathers_name": {
"type": [
"string",
"null"
],
"title": "Farther's name",
"description": "Father's name of the person.",
"maxLength": 60,
"examples": [
"John Smith"
]
},
"occupation": {
"type": [
"string",
"null"
],
"title": "Occupation",
"description": "Person's occupation.",
"maxLength": 60,
"examples": [
"Writer"
]
},
"assets": {
"type": [
"number",
"null"
],
"title": "Assets",
"description": "Person's assets.",
"examples": [
10.0
]
},
"income": {
"type": [
"number",
"null"
],
"title": "Income",
"description": "Person's income.",
"examples": [
112312.12
]
},
"net_worth": {
"type": [
"number",
"null"
],
"title": "Net worth",
"description": "Person's net worth.",
"examples": [
112312.12
]
}
}
},
"company": {
"type": "object",
"title": "Company information object",
"description": "Object with the entity's company information.",
"properties": {
"registration_number": {
"type": [
"string",
"null"
],
"title": "Registration number",
"description": "Number under which the company is registered.",
"maxLength": 30,
"examples": [
"123456"
]
},
"company_name": {
"type": [
"string",
"null"
],
"title": "Company name",
"description": "Company trading name.",
"maxLength": 60,
"examples": [
"Company name"
]
},
"activity": {
"type": [
"string",
"null"
],
"title": "Activity",
"description": "Company activity.",
"maxLength": 30,
"examples": [
"Manufacturing"
]
},
"company_type": {
"type": [
"string",
"null"
],
"title": "Company type",
"description": "Company type.",
"maxLength": 60,
"examples": [
"S.A",
"LTDA"
]
},
"company_format": {
"type": [
"string",
"null"
],
"title": "Company format",
"description": "Company classification.",
"maxLength": 60,
"examples": [
"ME",
"MEI"
]
},
"company_constitution_date": {
"type": [
"string",
"null"
],
"title": "Company consitution date",
"description": "Company's operational start date.",
"examples": [
"2000-01-01"
]
},
"occupation": {
"type": [
"string",
"null"
],
"title": "Occupation",
"description": "Company's main occupation.",
"maxLength": 60,
"examples": [
"Online Retail"
]
},
"annual_revenues": {
"type": [
"number",
"null"
],
"title": "Annual revenue",
"description": "Company's average monthly revenue for the last 12 months.",
"examples": [
10.0
]
},
"type": {
"type": [
"string",
"null"
],
"title": "Type",
"description": "Company's business relations type.",
"maxLength": 60,
"examples": [
"B2C"
]
},
"number_of_partners": {
"type": [
"integer",
"null"
],
"title": "Number of partners",
"description": "Company's number of partners.",
"examples": [
100
]
},
"perc_ownership": {
"type": [
"number",
"null"
],
"title": "Percentage of ownership",
"description": "Company's percentage of ownership.",
"examples": [
50
]
},
"fiscal_situation": {
"type": [
"string",
"null"
],
"title": "Fiscal situation",
"description": "Company's fiscal situation.",
"maxLength": 60,
"examples": [
"Maintenance"
]
},
"debt": {
"type": [
"number",
"null"
],
"title": "Debt amount",
"description": "Company's debt amount.",
"examples": [
18000
]
},
"income": {
"type": [
"number",
"null"
],
"title": "Income",
"description": "Company's income.",
"examples": [
112312.12
]
},
"net_worth": {
"type": [
"number",
"null"
],
"title": "Net worth",
"description": "Company's net worth.",
"examples": [
112312.12
]
},
"partners": {
"type": [
"array",
"null"
],
"title": "Partners",
"description": "This metadata object contains company's partner information, as specified in the client request at customer creation."
}
}
}
}
},
"customer": {
"type": "object",
"title": "Customer object",
"description": "Object with the customer properties. Each account can be linked to an entity through a customer. Accounts can have an unlimited number of customers attached to them, but only one of these customers can have the `isowner` attribute set to `true`. All other customers are automatically set to dependents with the `isowner` attribute set to `false`. The customer object controls attributes of an entity when associated with a given account. For example, the entity John Doe may have his office-issued phone number associated with his Visa corporate credit card customer and his private phone number associated with his private wallet customer. There are no parameters set at the customer level, but several account parameters use the `isowner` attribute to validate.",
"required": [
"id",
"is_owner",
"printed_name"
],
"properties": {
"id": {
"type": "integer",
"title": "Customer ID",
"description": "Unique ID associated with the Pismo customer. This field is used to retrieve customer details in the Pismo platform APIs.",
"examples": [
100602614
]
},
"nickname": {
"type": [
"string",
"null"
],
"title": "Nickname",
"description": "Customer nickname.",
"maxLength": 128
},
"printed_name": {
"title": "Printed name",
"description": "Customer name printed on the card. In the case where `printed_name` is not specified, the platform uses the `social_name` or `name` to create the `printed_name`.",
"maxLength": 25,
"examples": [
"Maria M Silva"
]
},
"social_name": {
"type": [
"string",
"null"
],
"title": "Social name",
"description": "Customer's social name.",
"maxLength": 64,
"examples": [
"Maria"
]
},
"is_owner": {
"type": "boolean",
"title": "Owner flag",
"description": "Flag that indicates if this customer is the owner of the account.",
"default": false,
"examples": [
true,
false
]
},
"email": {
"type": [
"string",
"null"
],
"title": "Email",
"description": "Customer's email.",
"maxLength": 255,
"examples": [
"[email protected]"
]
}
}
},
"account_id": {
"type": "integer",
"title": "Account ID",
"description": "Unique ID associated with the Pismo account.",
"examples": [
31700
]
}
}
}
Updated 3 days ago