Corporate account created

This event occurs when a new corporate account is created.
Generated by: Create corporate account
More information: Creating a corporate account

Type: object
Domain: account
Event: corporate_creation
Version: 1

account_id required

Title: Account ID
Description: Unique ID associated with the Pismo account. This field is used to retrieve the account in the Pismo platform APIs.
Type: integer
Example:
100602614

division_id required

Title: Division ID
Description: Unique ID used to identify the division in the Pismo platform APIs.
Type: string
Min length: 1
Max length: 36
Example:
df8d5b61-3cc0-4ec1-a72d-61860bff8fed

program_id required

Title: Program ID
Description: Unique ID used to identify the program in the Pismo platform APIs.
Type: integer
Example:
20

applicant required

Type: object

document_number required

Title: Document number
Description: Document number to identify the account holder. The value for this field is usually a government-issued tax ID number.
Type: string
Min length: 1
Max length: 15
Example:
03165757712

name required

Title: Name
Description: Person's or company's name.
Type: string
Min length: 1
Max length: 60
Example:
Company name

external_id

Title: External ID
Description: Custom entity ID string that uniquely identifies the entity within your organization.
Type: string or null
Min length: 0
Max length: 60
Example:
df8d5b61-3cc0-4ec1-a72d-61860bff8fed
custom_fields
Title: Custom fields
Description: Metadata field with any key-value pairs.
Type: object or null
Example:
{
    "custom_info": "value"
}

parent_account_id

Title: Parent account ID
Description: Unique ID of the associated parent account.
Type: integer or null
Example:
20

target_balance

Title: Target balance
Description: Target balance for the current account.
Type: number or null
Example:
100.0

external_id

Title: External ID
Description: Custom account ID string that uniquely identifies the account within your organization. This field is a key that links a Pismo account to your account ID.
Type: string or null
Min length: 0
Max length: 60
Example:
df8d5b61-3cc0-4ec1-a72d-61860bff8fed

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Corporate account created",
    "description": "This event occurs when a new corporate account is created. \n Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/post-account' target='_blank'>Create corporate account</a> \n More information: <a href='https://developers.pismo.io/pismo-docs/docs/creating-a-corporate-account-beta' target='_blank'>Creating a corporate account</a>",
    "type": "object",
    "required": [
        "account_id",
        "division_id",
        "program_id",
        "applicant"
    ],
    "properties": {
        "account_id": {
            "title": "Account ID",
            "description": "Unique ID associated with the Pismo account. This field is used to retrieve the account in the Pismo platform APIs.",
            "type": "integer",
            "minimum": 1,
            "maximum": 99999999999,
            "examples": [
                100602614
            ]
        },
        "division_id": {
            "title": "Division ID",
            "description": "Unique ID used to identify the division in the Pismo platform APIs.",
            "type": "string",
            "minLength": 1,
            "maxLength": 36,
            "examples": [
                "df8d5b61-3cc0-4ec1-a72d-61860bff8fed"
            ]
        },
        "program_id": {
            "title": "Program ID",
            "description": "Unique ID used to identify the program in the Pismo platform APIs.",
            "type": "integer",
            "minimum": 1,
            "maximum": 99999999999,
            "examples": [
                20
            ]
        },
        "applicant": {
            "$ref": "#/definitions/applicant"
        },
        "parent_account_id": {
            "title": "Parent account ID",
            "description": "Unique ID of the associated parent account.",
            "type": [
                "integer",
                "null"
            ],
            "minimum": 0,
            "maximum": 99999999999,
            "examples": [
                20
            ]
        },
        "target_balance": {
            "title": "Target balance",
            "description": "Target balance for the current account.",
            "type": [
                "number",
                "null"
            ],
            "minimum": -9223372036854775807,
            "maximum": 9223372036854775807,
            "examples": [
                100.0
            ]
        },
        "external_id": {
            "title": "External ID",
            "description": "Custom account ID string that uniquely identifies the account within your organization. This field is a key that links a Pismo account to your account ID.",
            "type": [
                "string",
                "null"
            ],
            "minLength": 0,
            "maxLength": 60,
            "examples": [
                "df8d5b61-3cc0-4ec1-a72d-61860bff8fed"
            ]
        }
    },
    "definitions": {
        "applicant": {
            "type": "object",
            "required": [
                "document_number",
                "name"
            ],
            "properties": {
                "document_number": {
                    "title": "Document number",
                    "description": "Document number to identify the account holder. The value for this field is usually a government-issued tax ID number.",
                    "type": [
                        "string"
                    ],
                    "minLength": 1,
                    "maxLength": 15,
                    "examples": [
                        "03165757712"
                    ]
                },
                "name": {
                    "title": "Name",
                    "description": "Person's or company's name.",
                    "type": [
                        "string"
                    ],
                    "minLength": 1,
                    "maxLength": 60,
                    "examples": [
                        "Company name"
                    ]
                },
                "external_id": {
                    "title": "External ID",
                    "description": "Custom entity ID string that uniquely identifies the entity within your organization.",
                    "type": [
                        "string",
                        "null"
                    ],
                    "minLength": 0,
                    "maxLength": 60,
                    "examples": [
                        "df8d5b61-3cc0-4ec1-a72d-61860bff8fed"
                    ]
                },
                "custom_fields": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "title": "Custom fields",
                    "description": "Metadata field with any key-value pairs.",
                    "examples": [
                        {
                            "custom_info": "value"
                        }
                    ]
                }
            }
        }
    }
}

{
    "account_id": 100602614,
    "division_id": "df8d5b61-3cc0-4ec1-a72d-61860bff8fed",
    "program_id": 20,
    "applicant": {
        "document_number": "03165757712",
        "name": "Company name",
        "external_id": "df8d5b61-3cc0-4ec1-a72d-61860bff8fed",
        "custom_fields": {
            "custom_info": "value"
        }
    },
    "parent_account_id": 20,
    "target_balance": 100.0,
    "external_id": "df8d5b61-3cc0-4ec1-a72d-61860bff8fed"
}

Updated 23 days ago