Account application prospect created

This event occurs when the platform creates an account application prospect.
Generated by: Create account application with the submit property set to false
More information: Create or update account

Type: object
Domain: onboarding
Event: prospect
Version: 1

|
applicationId

Title: The identifier for the application form.
Type: integer

acquisitionChannel

Title: Onboarding acquisition channel. A program has many Acquisition Channel, generally used to identify by where users was registered.
Type: integer

dueDate

Title: Due date ID. Used to identify choose date by client.
Type: integer

statusCode

Title: Application status code
Type: integer

statusName

Title: Application status name
Type: string

prospectCancel

Title: Used to cancel a prospect created
Type: boolean
Example:
true
false

program

Title: Program information.
Type: object

id required

Title: Program ID - Identifier
Type: integer

type required

Title: Program type definitions.
Type: object

id required

Title: Program Type ID - Identifier
Type: integer

description required

Title: Program Type description.
Type: string
Example:
CREDITO
PRE-PAGO
DEBITO
ALIMENTACAO
MERCHANT
CONTA-CORRENTE

pci required

Title: Is program type inside a PCI context?
Type: boolean
Example:
true
false

applicant

Type: object

documentNumber required

Description: The company or person document. E.g: In Brazil, it will be the unformatted value of the CPF/CNPJ (only number)
Type: string
Example:
03165757712

birthDate

Description: Birth date
Type: string or null

personal

Title: The applicant's personal information
Type: object

externalId

Description: A key defined by the client. It can have any format
Type: string or null
Example:
3d0ca315-aff9–4fc2-be61–3b76b9a2d798

name

Type: string

email

Type: string

gender

Type: string or null
Must be one of the following:
M
F

printedName

Description: The name that must be printed in the card
Type: string or null

nickname

Type: string or null

socialName

Description: Social name, can be different of the document name
Type: string or null

countryOfBirth

Type: string or null
Example:
Brazil

cityOfBirth

Type: string or null
Example:
Campo Belo

stateOfBirth

Type: string or null

educationDegree

Type: string or null

maritalStatus

Type: string or null
Example:
SINGLE
MARRIED

fathersName

Type: string or null

mothersName

Type: string or null

nationality

Type: string or null

otherIdNumber

Description: Another document id. E.g. Driver license number
Type: string or null

documentType

Description: The otherIdNumber document type. E.g. Drive license
Type: string or null

documentIssuedBy

Type: string or null
Example:
SSP
PC

documentIssuedAt

Description: Where the document was issued
Type: string or null
Example:
RJ
SP

documentIssuedDate

Type: string or null

occupation

Description: Person job
Type: string or null

assets

Description: Person assets
Type: string or null

income

Description: Person income
Type: string or null

netWorth

Description: Person net worth
Type: string or null

pep

Description: Indicates if person is politically exposed
Type: string or null
Example:
true
false

statutory

Type: string or null
Example:
true
false

company

Title: The applicant's company information
Type: object

externalId

Description: A key defined by the client. It can have any format
Type: string or null
Example:
3d0ca315-aff9–4fc2-be61–3b76b9a2d798

name required

Description: The same as the document
Type: string

email

Type: string or null

registrationNumber

Type: string or null

companyName

Description: Trading name
Type: string or null

activity

Description: Company activity
Type: string or null

companyType

Type: string or null
Example:
S.A
LTDA

companyFormat

Description: It's related to the company classification
Type: string or null
Example:
ME
MEI

companyConstitutionDate

Type: string or null

occupation

Description: It also can be the company activity
Type: string or null

annualRevenues

Type: string or null
Example:
112312.12

type

Description: Always is 2
Type: string or null

numberOfPartners

Type: string or null
Example:
1
2

percOwnership

Description: Percentual of ownership
Type: string or null
Example:
30

fiscalSituation

Description: Company fiscal situation
Type: string or null

debt

Type: string or null
Example:
1800

income

Description: Company income
Type: string or null
Example:
112312.12

netWorth

Description: Company net worth
Type: string or null
Example:
112312.12

partner

Title: The company partner information. This is a metadata, so this object returns what we receive from the onboarding request
Type: ['object', 'null']

partners

Title: List of partners
Type: array

addresses

Title: List of addresses
Type: array or null

addressExternalId

Type: string or null

zipCode

Description: Zipcode. Depends on the region. E.g. In Brasil it's CEP
Type: string or null

address

Description: The street/avenue/etc name
Type: string or null

number

Description: The number of the address. Accepts only numbers
Type: string or null

neighborhood

Type: string or null

complementaryAddress

Type: string or null

city

Type: string

state

Type: string
Example:
SP
AC
RJ

country

Type: string or null
Example:
Brasil

addressType

Type: string
Example:
COMMERCIAL
OTHER
RESIDENTIAL

mailingAddress

Description: Indicates if is the mailing address
Type: boolean or null

phones

Title: A list of phone numbers
Type: array or null

phoneType required

Description: Indicates the phone type
Type: string
Example:
MOBILE
RESIDENTIAL
COMMERCIAL

phone required

Type: string
Example:
999618921

extension

Description: Phone's extension
Type: string or null
Example:
Ramal 32

custom_fields

Title: Custom fields
Description: CustomFields field with any key-value pairs.
Type: object or null
Example:

{
    "value_1": 800,
    "value_2": "17f43184-f1b5-4bac-9fba-49e2d178d1a4"
}
customFields

Description: It's possible to insert any value
Type: object or null
Example:
Any value

account

Title: The applicant's account options
Type: object

exchangeMode

Title: Wether any foreign transaction should be charged by the exchange rate at the day it occurred or at the statement's closing date
Type: string
Must be one of the following:
SAME_DAY
CLOSING

grantedLimit

Description: Credit limit granted to the account
Type: string

limit

Description: Account's limit
Type: string

externalId

Description: A key defined by the client. It can have any format
Type: string or null
Max length: 60
Example:
3d0ca315-aff9–4fc2-be61–3b76b9a2d798

division_id

Title: Account's administrative division ID
Type: integer
Example:
2856813

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://pismo.io/events/account/application-prospect.json",
    "type": "object",
    "title": "Account application prospect created",
    "description": "This event occurs when the platform creates an account application prospect.<br>Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/post-acquisitions-v3-s2s-applications' target='_blank'>Create account application</a> with the `submit` property set to `false` <br>More information: <a href='https://developers.pismo.io/pismo-docs/docs/create-an-account' target='_blank'>Create or update account</a>",
    "required": [],
    "properties": {
        "applicationId": {
            "type": "integer",
            "title": "The identifier for the application form."
        },
        "acquisitionChannel": {
            "type": "integer",
            "title": "Onboarding acquisition channel. A program has many Acquisition Channel, generally used to identify by where users was registered."
        },
        "dueDate": {
            "type": "integer",
            "title": "Due date ID. Used to identify choose date by client."
        },
        "statusCode": {
            "type": "integer",
            "title": "Application status code"
        },
        "statusName": {
            "type": "string",
            "title": "Application status name"
        },
        "prospectCancel": {
            "type": "boolean",
            "title": "Used to cancel a prospect created",
            "default": false,
            "examples": [
                true,
                false
            ]
        },
        "program": {
            "type": "object",
            "title": "Program information.",
            "required": [
                "id",
                "type"
            ],
            "properties": {
                "id": {
                    "type": "integer",
                    "title": "Program ID - Identifier"
                },
                "type": {
                    "type": "object",
                    "title": "Program type definitions.",
                    "required": [
                        "id",
                        "description",
                        "pci"
                    ],
                    "properties": {
                        "id": {
                            "type": "integer",
                            "title": "Program Type ID - Identifier"
                        },
                        "description": {
                            "type": "string",
                            "title": "Program Type description.",
                            "examples": [
                                "CREDITO",
                                "PRE-PAGO",
                                "DEBITO",
                                "ALIMENTACAO",
                                "MERCHANT",
                                "CONTA-CORRENTE"
                            ]
                        },
                        "pci": {
                            "type": "boolean",
                            "title": "Is program type inside a PCI context?",
                            "examples": [
                                true,
                                false
                            ]
                        }
                    }
                }
            }
        },
        "applicant": {
            "type": "object",
            "required": [
                "documentNumber"
            ],
            "properties": {
                "documentNumber": {
                    "type": "string",
                    "description": "The company or person document. E.g: In Brazil, it will be the unformatted value of the CPF/CNPJ (only number)",
                    "examples": [
                        "03165757712"
                    ]
                },
                "birthDate": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Birth date",
                    "pattern": "^([0-2][0-9]|(3)[0-1])(/)(((0)[0-9])|((1)[0-2]))(/)\\d{4}$"
                },
                "personal": {
                    "$ref": "#/definitions/personal"
                },
                "company": {
                    "$ref": "#/definitions/company"
                },
                "addresses": {
                    "type": [
                        "array",
                        "null"
                    ],
                    "title": "List of addresses",
                    "items": {
                        "$ref": "#/definitions/address"
                    }
                },
                "customFields": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "description": "It's possible to insert any value",
                    "examples": [
                        "Any value"
                    ]
                },
                "account": {
                    "$ref": "#/definitions/account"
                }
            }
        }
    },
    "definitions": {
        "personal": {
            "type": "object",
            "title": "The applicant's personal information",
            "properties": {
                "externalId": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "A key defined by the client. It can have any format",
                    "examples": [
                        "3d0ca315-aff9\u20134fc2-be61\u20133b76b9a2d798"
                    ]
                },
                "name": {
                    "type": "string"
                },
                "email": {
                    "type": "string"
                },
                "gender": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "enum": [
                        "M",
                        "F"
                    ]
                },
                "printedName": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "The name that must be printed in the card"
                },
                "nickname": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "socialName": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Social name, can be different of the document name"
                },
                "countryOfBirth": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "examples": [
                        "Brazil"
                    ]
                },
                "cityOfBirth": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "examples": [
                        "Campo Belo"
                    ]
                },
                "stateOfBirth": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "educationDegree": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "maritalStatus": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "examples": [
                        "SINGLE",
                        "MARRIED"
                    ]
                },
                "fathersName": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "mothersName": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "nationality": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "otherIdNumber": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Another document id. E.g. Driver license number"
                },
                "documentType": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "The otherIdNumber document type. E.g. Drive license"
                },
                "documentIssuedBy": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "examples": [
                        "SSP",
                        "PC"
                    ]
                },
                "documentIssuedAt": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Where the document was issued",
                    "examples": [
                        "RJ",
                        "SP"
                    ]
                },
                "documentIssuedDate": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "pattern": "^([0-2][0-9]|(3)[0-1])(/)(((0)[0-9])|((1)[0-2]))(/)\\d{4}$"
                },
                "occupation": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Person job"
                },
                "assets": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Person assets"
                },
                "income": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Person income"
                },
                "netWorth": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Person net worth"
                },
                "pep": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Indicates if person is politically exposed",
                    "examples": [
                        "true",
                        "false"
                    ]
                },
                "statutory": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "examples": [
                        "true",
                        "false"
                    ]
                }
            }
        },
        "partner": {
            "type": [
                "object",
                "null"
            ],
            "title": "The company partner information. This is a metadata, so this object returns what we receive from the onboarding request"
        },
        "company": {
            "type": "object",
            "title": "The applicant's company information",
            "required": [
                "name"
            ],
            "properties": {
                "externalId": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "A key defined by the client. It can have any format",
                    "examples": [
                        "3d0ca315-aff9\u20134fc2-be61\u20133b76b9a2d798"
                    ]
                },
                "name": {
                    "type": "string",
                    "description": "The same as the document"
                },
                "email": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "registrationNumber": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "companyName": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Trading name"
                },
                "activity": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Company activity"
                },
                "companyType": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "examples": [
                        "S.A",
                        "LTDA"
                    ]
                },
                "companyFormat": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "It's related to the company classification",
                    "examples": [
                        "ME",
                        "MEI"
                    ]
                },
                "companyConstitutionDate": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "pattern": "^([0-2][0-9]|(3)[0-1])(/)(((0)[0-9])|((1)[0-2]))(/)\\d{4}$"
                },
                "occupation": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "It also can be the company activity"
                },
                "annualRevenues": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "examples": [
                        "112312.12"
                    ]
                },
                "type": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Always is 2"
                },
                "numberOfPartners": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "examples": [
                        "1",
                        "2"
                    ]
                },
                "percOwnership": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Percentual of ownership",
                    "examples": [
                        "30"
                    ]
                },
                "fiscalSituation": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Company fiscal situation"
                },
                "debt": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "examples": [
                        "1800"
                    ]
                },
                "income": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Company income",
                    "examples": [
                        "112312.12"
                    ]
                },
                "netWorth": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Company net worth",
                    "examples": [
                        "112312.12"
                    ]
                },
                "partner": {
                    "$ref": "#/definitions/partner"
                },
                "partners": {
                    "type": "array",
                    "title": "List of partners",
                    "items": {
                        "$ref": "#/definitions/partner"
                    }
                }
            }
        },
        "address": {
            "type": "object",
            "title": "Address",
            "required": [],
            "properties": {
                "addressExternalId": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "zipCode": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Zipcode. Depends on the region. E.g. In Brasil it's CEP"
                },
                "address": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "The street/avenue/etc name"
                },
                "number": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "The number of the address. Accepts only numbers"
                },
                "neighborhood": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "complementaryAddress": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "city": {
                    "type": "string"
                },
                "state": {
                    "type": "string",
                    "examples": [
                        "SP",
                        "AC",
                        "RJ"
                    ]
                },
                "country": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "examples": [
                        "Brasil"
                    ]
                },
                "addressType": {
                    "type": "string",
                    "examples": [
                        "COMMERCIAL",
                        "OTHER",
                        "RESIDENTIAL"
                    ]
                },
                "mailingAddress": {
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "description": "Indicates if is the mailing address"
                },
                "phones": {
                    "type": [
                        "array",
                        "null"
                    ],
                    "title": "A list of phone numbers",
                    "items": {
                        "$ref": "#/definitions/phone"
                    }
                },
                "custom_fields": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "title": "Custom fields",
                    "description": "CustomFields field with any key-value pairs.",
                    "examples": [
                        {
                            "value_1": 800,
                            "value_2": "17f43184-f1b5-4bac-9fba-49e2d178d1a4"
                        }
                    ]
                }
            }
        },
        "phone": {
            "type": "object",
            "title": "Phone item",
            "required": [
                "phoneType",
                "phone"
            ],
            "properties": {
                "phoneType": {
                    "type": "string",
                    "description": "Indicates the phone type",
                    "examples": [
                        "MOBILE",
                        "RESIDENTIAL",
                        "COMMERCIAL"
                    ]
                },
                "phone": {
                    "type": "string",
                    "examples": [
                        "999618921"
                    ]
                },
                "extension": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "Phone's extension",
                    "examples": [
                        "Ramal 32"
                    ]
                }
            }
        },
        "account": {
            "type": "object",
            "title": "The applicant's account options",
            "properties": {
                "exchangeMode": {
                    "type": "string",
                    "title": "Wether any foreign transaction should be charged by the exchange rate at the day it occurred or at the statement's closing date",
                    "enum": [
                        "SAME_DAY",
                        "CLOSING"
                    ]
                },
                "grantedLimit": {
                    "type": "string",
                    "description": "Credit limit granted to the account"
                },
                "limit": {
                    "type": "string",
                    "description": "Account's limit"
                },
                "externalId": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "A key defined by the client. It can have any format",
                    "maxLength": 60,
                    "examples": [
                        "3d0ca315-aff9\u20134fc2-be61\u20133b76b9a2d798"
                    ]
                },
                "division_id": {
                    "type": "integer",
                    "title": "Account's administrative division ID",
                    "example": 2856813
                }
            }
        }
    }
}