# Create account application (deprecated) This endpoint is **DEPRECATED**. Use the new [Create account application](ref:post-acquisitions-v3-s2s-applications) instead. Create a new account application. If the `submit` property is set to `false`: - The application is not sent for processing and can be further PATCH-ed with incremental changes. - This endpoint generates an [Account application prospect created](https://developers.pismo.io/events/docs/onboarding-prospect-1) event. If the `submit` flag is set to `true`: - No further updates can be made and the account application is sent out for processing, which creates an account and its associated structures. - This endpoint generates an [Account application created](https://developers.pismo.io/events/docs/onboarding-succeeded-1) event. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Core platform - Accounts", "version": "1.0.0", "description": "API used to manage accounts domain", "contact": { "name": "API Support", "url": "https://developers.pismo.io/support/" }, "license": { "name": "Copyright Pismo" } }, "servers": [ { "url": "https://sandbox.pismolabs.io", "description": "API server for testing" } ], "tags": [ { "name": "Accounts", "description": "Endpoints to manage accounts" } ], "components": { "schemas": { "AccountDueDateID": { "type": "integer", "format": "int64", "description": "Program due date ID. This field is **REQUIRED** only for Full balance credit programs. \n\nProgram due dates and their IDs are set when you [create a program](https://developers.pismo.io/pismo-docs/reference/createprogrambasedontemplate).\n", "example": 222 }, "AccountDuplicityByExternalIdError": { "title": "AccountDuplicityByExternalIdError", "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Message describing the error" }, "org_id": { "$ref": "#/components/schemas/OrganizationID" }, "account_id": { "$ref": "#/components/schemas/AccountID" }, "application_id": { "$ref": "#/components/schemas/ApplicationID" }, "customer_id": { "$ref": "#/components/schemas/CustomerID" }, "entity_id": { "$ref": "#/components/schemas/EntityID" }, "program_id": { "$ref": "#/components/schemas/ProgramID" } } }, "IndividualsEmailAddress": { "type": "string", "description": "Email address.", "format": "email", "maxLength": 100, "example": "jenna.flect@email.com" }, "AccountExternalId": { "type": "string", "description": "\nClient-created ID from an external system or application. **REQUIRED** for `VIRTUAL` accounts.\n", "maxLength": 60, "example": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f" }, "AccountID": { "type": "integer", "format": "int64", "description": "Account ID", "example": 1001 }, "AccountIdNonchecking": { "type": "integer", "format": "int64", "description": "Created account ID. `null` if the application has not been proccessed yet (non-checking accounts only).", "example": 123 }, "AccountLimit": { "type": "integer", "format": "int64", "description": "\nClient-defined account limit. Must be between 0 and the `granted_limit` (aka `max_credit_limit`).\n\nDefaults to zero (0) if not passed. \n\n This field is called `total_credit_limit` in the [Update account limits](https://developers.pismo.io/pismo-docs/reference/patch-v1-account-limit) endpoint and the [Account limits](https://developers.pismo.io/pismo-docs/docs/working-with-limits-objects) guide.\n", "example": 750 }, "AccountType": { "type": "string", "description": "\nAccount type:\n\n- `PHYSICAL`—Default. A parent account is always physical. A child account can be physical or virtual. \n\n A *physical* card is a plastic or metal embossed card. \"Physical\" here means an account that represents an actual client entity (person or company). A physical account supports full operations— transfers, payments, cards, interest, statements, and so on. \n\n- `VIRTUAL`—Always a child account. \n\n `parent_account_id` and `external_id` are **REQUIRED** for virtual accounts. \n \n Virtual accounts can have a many to one mapping to a physical account where the balance lives at the parent account. \n\nWhile a `document_number` is **REQUIRED** for a virtual account, it is ignored since it shares a parent account's entity and `document_number`.\n\n**Key difference summary**\n\n| Feature | Physical | Virtual |\n| ------------------------------ | ------------------ | -------------------------- |\n| Fund ownership | Yes | No (parent owns funds) |\n| Independent balance | Usually | Typically parent balance |\n| Persistent ID | One account | Can be many to one parent |\n| Regulatory/KYC link | Direct | Inherited/indirect |\n| Primary use | Real account | Segmentation & routing | \n", "enum": [ "PHYSICAL", "VIRTUAL" ], "example": "PHYSICAL" }, "AcquisitionChannelID": { "type": "integer", "format": "int64", "description": "Application's acquisition channel ID. An acquisition channel is how a customer was referred to the site, such as through a web app or mobile app.\n\nYou can call [List acquistion channels](https://developers.pismo.io/pismo-docs/reference/get-acquisitions-v2-programs-programid-channels) to find channels registered for your account.\n", "example": 111 }, "AcquisitionRequestOutdated": { "type": "object", "description": "Application form", "required": [ "submit", "applicant" ], "properties": { "submit": { "$ref": "#/components/schemas/Submit" }, "acquisition_channel": { "$ref": "#/components/schemas/AcquisitionChannelID" }, "program_id": { "$ref": "#/components/schemas/ProgramID2" }, "due_date": { "$ref": "#/components/schemas/AccountDueDateID" }, "applicant": { "$ref": "#/components/schemas/Applicant2" } } }, "AcquisitionResponse": { "type": "object", "description": "Aquisition form was successfully created.", "required": [ "application_id", "status", "status_name", "account_id", "customer_id", "entity_id", "program_id" ], "properties": { "application_id": { "$ref": "#/components/schemas/ApplicationIdNonchecking" }, "status": { "$ref": "#/components/schemas/ApplicationStatusIdNonchecking" }, "status_name": { "$ref": "#/components/schemas/ApplicationStatusNameNonchecking" }, "account_id": { "$ref": "#/components/schemas/AccountIdNonchecking" }, "customer_id": { "$ref": "#/components/schemas/CustomerIdNonchecking" }, "entity_id": { "$ref": "#/components/schemas/EntityID2" }, "program_id": { "$ref": "#/components/schemas/ProgramID" } } }, "Activity": { "type": "string", "description": "Company's general field of activity", "maxLength": 30, "example": "Manufacturing" }, "Address": { "type": "string", "description": "Street, avenue, road, and so on, name.", "maxLength": 300, "example": "Mulholland Drive" }, "AddressNumberInput": { "type": "string", "maxLength": 9, "description": "Address number as string or integer. \n\nIf you enter numeric characters, they are saved in the `number` address object field.\n\nIf you enter any non-numeric characters, all characters are saved in the `extended_number` address object field. \n\nFor example, if you enter \"12 A\", it gets saved as follows:\n * `number` = 12\n * `extended_number` = \"12 A\"\n" }, "AddressType": { "type": "string", "description": "Address type", "enum": [ "RESIDENTIAL", "COMMERCIAL", "OTHER" ], "example": "RESIDENTIAL" }, "Applicant2": { "type": "object", "description": "Applicant's details", "required": [ "document_number" ], "properties": { "document_number": { "$ref": "#/components/schemas/DocumentNumberSetOnce" }, "birth_date": { "$ref": "#/components/schemas/BirthDate" }, "personal": { "$ref": "#/components/schemas/ApplicantPersonal" }, "company": { "$ref": "#/components/schemas/ApplicantCompany" }, "account": { "$ref": "#/components/schemas/ApplicantAccount" }, "addresses": { "$ref": "#/components/schemas/ApplicantAddresses" }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } } }, "ApplicantAccount": { "type": "object", "description": "Applicant's account options", "properties": { "currency_numeric_code": { "$ref": "#/components/schemas/CurrencyNumericCode" }, "granted_limit": { "$ref": "#/components/schemas/GrantedLimit" }, "limit": { "$ref": "#/components/schemas/AccountLimit" }, "exchange_mode": { "$ref": "#/components/schemas/ExchangeMode" }, "external_id": { "$ref": "#/components/schemas/AccountExternalId" }, "parent_account_id": { "$ref": "#/components/schemas/ParentAccountID" }, "overdraft_limit": { "$ref": "#/components/schemas/OverdraftLimit" }, "account_type": { "$ref": "#/components/schemas/AccountType" }, "division_id": { "$ref": "#/components/schemas/DivisionID" } } }, "ApplicantAddresses": { "description": "List of addresses", "type": "array", "items": { "type": "object", "required": [ "address", "city", "state", "country", "address_type", "zip_code", "neighborhood" ], "properties": { "address": { "$ref": "#/components/schemas/Address" }, "number": { "$ref": "#/components/schemas/AddressNumberInput" }, "city": { "$ref": "#/components/schemas/City" }, "state": { "$ref": "#/components/schemas/State2" }, "country": { "$ref": "#/components/schemas/Country" }, "address_type": { "$ref": "#/components/schemas/AddressType" }, "zip_code": { "$ref": "#/components/schemas/ZipCode2" }, "neighborhood": { "$ref": "#/components/schemas/Neighborhood" }, "complementary_address": { "$ref": "#/components/schemas/ComplementaryAddress" }, "mailing_address": { "$ref": "#/components/schemas/MailingAddress" }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } } } }, "ApplicantCompany": { "type": "object", "description": "Applicant's company information. Either this or the `personal` object is **REQUIRED**. Pass one or the other but not both.", "required": [ "name" ], "properties": { "external_id": { "$ref": "#/components/schemas/CompanyExternalId" }, "name": { "$ref": "#/components/schemas/CompanyName" }, "email": { "$ref": "#/components/schemas/CompanyEmail" }, "company_name": { "$ref": "#/components/schemas/CompanyBrandName" }, "registration_number": { "$ref": "#/components/schemas/RegistrationNumber" }, "activity": { "$ref": "#/components/schemas/Activity" }, "company_type": { "$ref": "#/components/schemas/CompanyType" }, "company_format": { "$ref": "#/components/schemas/CompanyFormat" }, "company_constitution_date": { "$ref": "#/components/schemas/CompanyConstitutionDate" }, "occupation": { "$ref": "#/components/schemas/CompanyOccupation" }, "income": { "$ref": "#/components/schemas/CompanyIncome" }, "net_worth": { "$ref": "#/components/schemas/CompanyNetWorth" }, "annual_revenues": { "$ref": "#/components/schemas/AverageMonthlyRevenue" }, "type": { "$ref": "#/components/schemas/CompanyBusinessRelationsType" }, "number_of_partners": { "$ref": "#/components/schemas/NumberOfPartners" }, "perc_ownership": { "$ref": "#/components/schemas/PercOwnership2" }, "fiscal_situation": { "$ref": "#/components/schemas/FiscalSituation" }, "debt": { "$ref": "#/components/schemas/CompanyDebt" }, "partners": { "description": "Company partners", "type": "array", "items": { "$ref": "#/components/schemas/Partner" } } } }, "ApplicantIncome2": { "type": "integer", "format": "int64", "description": "Applicant's income", "example": 4000 }, "ApplicantNetWorth": { "type": "integer", "format": "int64", "description": "Applicant's net worth", "example": 20000 }, "ApplicantPersonal": { "type": "object", "description": "Applicant's personal information. Either this or the `company` object is **REQUIRED**. Pass one or the other but not both.", "properties": { "external_id": { "$ref": "#/components/schemas/PersonalExternalId" }, "name": { "$ref": "#/components/schemas/IndividualsName2" }, "email": { "$ref": "#/components/schemas/IndividualsEmailAddress" }, "gender": { "$ref": "#/components/schemas/Gender" }, "printed_name": { "$ref": "#/components/schemas/PrintedName2" }, "nickname": { "$ref": "#/components/schemas/Nickname" }, "social_name": { "$ref": "#/components/schemas/SocialName2" }, "country_of_birth": { "$ref": "#/components/schemas/CountryOfBirth" }, "state_of_birth": { "$ref": "#/components/schemas/StateOfBirth" }, "city_of_birth": { "$ref": "#/components/schemas/CityOfBirth" }, "registration": { "$ref": "#/components/schemas/ApplicantRegistration" }, "education_degree": { "$ref": "#/components/schemas/EducationDegree" }, "marital_status": { "$ref": "#/components/schemas/MaritalStatus" }, "fathers_name": { "$ref": "#/components/schemas/FathersName" }, "mothers_name": { "$ref": "#/components/schemas/MothersName" }, "nationality": { "$ref": "#/components/schemas/Nationality" }, "other_id_number": { "$ref": "#/components/schemas/OtherIdNumber" }, "document_type": { "$ref": "#/components/schemas/DocumentType" }, "document_issued_by": { "$ref": "#/components/schemas/DocumentIssuedBy" }, "document_issued_at": { "$ref": "#/components/schemas/DocumentIssuedAt" }, "document_issued_date": { "$ref": "#/components/schemas/DocumentIssuedDate" }, "occupation": { "$ref": "#/components/schemas/ApplicantOccupation" }, "assets": { "$ref": "#/components/schemas/Assets" }, "income": { "$ref": "#/components/schemas/ApplicantIncome2" }, "net_worth": { "$ref": "#/components/schemas/ApplicantNetWorth" }, "pep": { "$ref": "#/components/schemas/PEP" }, "statutory": { "$ref": "#/components/schemas/Statutory" } } }, "ApplicantOccupation": { "type": "string", "description": "Applicant's occupation", "maxLength": 60, "example": "Creative Accountant" }, "ApplicantRegistration": { "type": "object", "description": "Applicant's document information", "properties": { "number": { "type": "string", "description": "Document number, such as a tax ID.", "maxLength": 15, "example": "1234567890" } } }, "ApplicationID": { "type": "integer", "format": "int64", "description": "Application ID" }, "ApplicationIdNonchecking": { "type": "integer", "format": "int64", "description": "Application form ID (non-checking accounts only)", "example": 1234 }, "ApplicationStatusIdNonchecking": { "type": "integer", "format": "int64", "description": "Application status ID", "example": 4 }, "ApplicationStatusNameNonchecking": { "type": "string", "description": "Application status. Most likely to be\n* `REGISTERED` - Application was saved, but not started processing yet.\n* `APPROVED` - Application has finished processing.\n* `PROSPECT` - Application was created with `submit` = `false`.\n", "example": "APPROVED" }, "Assets": { "type": "number", "format": "float", "description": "Assets", "example": 40000 }, "AverageMonthlyRevenue": { "type": "integer", "format": "int64", "description": "Average monthly revenue for the last 12 months", "example": 33000 }, "BirthDate": { "type": "string", "description": "Birth date. Format = dd/mm/yyyy.", "example": "31/12/1980" }, "City": { "type": "string", "description": "Address city", "maxLength": 100, "example": "San Diego" }, "CityOfBirth": { "type": "string", "description": "Birth city", "maxLength": 60, "example": "San Diego" }, "CompanyBrandName": { "type": "string", "description": "Company's brand name", "maxLength": 60, "example": "Acme General Products" }, "CompanyBusinessRelationsType": { "type": "string", "example": "B2C", "description": "Company's business relations type", "maxLength": 60 }, "CompanyConstitutionDate": { "type": "string", "description": "Company's operational start date. Format = yyyy-mm-dd.", "format": "date", "example": "2004-01-20" }, "CompanyDebt": { "type": "integer", "format": "int64", "description": "Company's debt", "example": 18000 }, "CompanyEmail": { "type": "string", "description": "Company's registered email", "maxLength": 100, "example": "acme@acmemail.com" }, "CompanyExternalId": { "type": "string", "description": "Client-provided company ID from an external system.", "maxLength": 60, "example": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f" }, "CompanyFormat": { "type": "string", "description": "Company social type", "maxLength": 60, "example": "ME" }, "CompanyIncome": { "type": "integer", "format": "int64", "description": "Company's income", "example": 10000 }, "CompanyName": { "type": "string", "description": "Company's legal name", "maxLength": 150, "example": "Acme Inc." }, "CompanyNetWorth": { "type": "integer", "format": "int64", "description": "Company's net worth", "example": 20000 }, "CompanyOccupation": { "type": "string", "description": "Company's main occupation", "maxLength": 60, "example": "Online retail" }, "CompanyType": { "type": "string", "description": "Company type", "maxLength": 60, "example": "Retailer" }, "ComplementaryAddress": { "type": "string", "description": "Any additional information such as suite, apt., and so on.", "maxLength": 100, "example": "Apt 1408" }, "Country": { "type": "string", "description": "Address country", "maxLength": 30, "example": "Brazil" }, "CountryOfBirth": { "type": "string", "description": "Birth country", "maxLength": 60, "example": "India" }, "CurrencyNumericCode": { "type": "string", "description": "ISO 4217 code for account's currency. If not defined, the Pismo platform uses the program currency code. If not defined at the program level, the platform uses the currency code defined at the organization level.\n", "maxLength": 3, "example": "986" }, "CustomerID": { "type": "integer", "format": "int64", "description": "Customer ID", "example": 100211299 }, "CustomerIdNonchecking": { "type": "integer", "format": "int64", "description": "Created customer ID. `null` if the application has not yet been proccessed (non-checking accounts only).", "example": 123 }, "CustomFields": { "type": "object", "description": "Key/value field for custom information. (Limited to 1014 bytes.)", "example": { "field_01": "value01", "field_02": "value02" } }, "DivisionID": { "type": "integer", "format": "int64", "description": "Account's administrative division ID", "example": 2856813 }, "DocumentIssuedAt": { "type": "string", "description": "Document issuer location. This is a free-form field, not an ISO standard.", "maxLength": 30, "example": "Brazil" }, "DocumentIssuedBy": { "type": "string", "description": "Document issuer", "maxLength": 30 }, "DocumentIssuedDate": { "type": "string", "description": "Date document was issued. Format = dd/mm/yyyy.", "example": "01/31/1970" }, "DocumentNumber": { "type": "string", "maxLength": 15, "description": "Document number, such as a government tax ID.", "example": "31457828046" }, "DocumentNumberSetOnce": { "type": "string", "description": "Applicant's document number (such as a government tax ID). \n\nFor a company, this can be something like its tax or business registration number.\n\n**Important**: Once passed, this value **CANNOT** be changed, even if `submit` is `false`.\n", "maxLength": 15, "example": "12345678910" }, "DocumentType": { "type": "string", "description": "Document type. Free-form field, not an enum.", "maxLength": 30 }, "EducationDegree": { "type": "string", "description": "Education degree", "maxLength": 30 }, "EntityID": { "type": "integer", "format": "int64", "description": "Entity ID", "minimum": 1, "example": 1234567891 }, "EntityID2": { "type": "integer", "format": "int64", "description": "Created entity ID. `null` if the application has not yet been proccessed (non-checking accounts only).", "example": 123 }, "ExchangeMode": { "type": "string", "description": "When a foreign transaction is charged the exchange rate: \n\n* `SAME_DAY` - Day the transaction occurred\n* `CLOSING` - Statement's closing date\n\nThis field is valid for credit [programs](https://developers.pismo.io/pismo-docs/docs/program-types) **only**.\n", "enum": [ "SAME_DAY", "CLOSING" ], "example": "SAME_DAY" }, "FathersName": { "type": "string", "description": "Father's name", "maxLength": 60, "example": "Steven Douglas" }, "FiscalSituation": { "type": "string", "description": "Company's fiscal situation.", "maxLength": 60, "example": "Good" }, "Gender": { "type": "string", "description": "Gender", "maxLength": 1, "enum": [ "F", "M", "" ], "example": "M" }, "GrantedLimit": { "type": "integer", "format": "int64", "description": "Account's credit limit. \n\n**REQUIRED** for credit programs. \n\nThis field is called `max_credit_limit` in the [Update account limits](https://developers.pismo.io/pismo-docs/reference/patch-v1-account-limit) endpoint and the [Account limits](https://developers.pismo.io/pismo-docs/docs/working-with-limits-objects) guide.\n", "example": 1500 }, "IndividualsName": { "type": "string", "description": "Name", "example": "Hyman Roth" }, "IndividualsName2": { "type": "string", "description": "Name. **REQUIRED** if `social_name` is not provided.", "maxLength": 150, "example": "Hyman Roth" }, "MailingAddress": { "type": "boolean", "description": "Is this address the mailing address?\n\nOnly one address can have this field set to `true`.\n", "example": true }, "MaritalStatus": { "type": "string", "description": "Marital status", "enum": [ "SINGLE", "MARRIED", "DIVORCED", "WIDOWER" ], "example": "MARRIED" }, "MothersName": { "type": "string", "description": "Mother's name", "maxLength": 60, "example": "Kay Sadilla" }, "Nationality": { "type": "string", "description": "Nationality", "maxLength": 60, "example": "Australian" }, "Neighborhood": { "type": "string", "description": "Address neighborhood. Some countries use neighborhood in addresses.", "maxLength": 100, "example": "Shady Pines" }, "Nickname": { "type": "string", "description": "Nickname.", "maxLength": 128, "example": "Pinto" }, "NumberOfPartners": { "type": "integer", "format": "int32", "description": "Number of company partners", "example": 3 }, "OrganizationID": { "type": "string", "description": "Organization ID", "example": "TN-34778262-f4f0-464d-b4c6-a14e2dc6f4be" }, "OtherIdNumber": { "type": "string", "description": "Another ID number", "example": "29000000" }, "OverdraftLimit": { "type": "integer", "format": "int64", "example": 750, "description": "Maximum issuer-granted limit for overdraft spending on debit accounts" }, "ParentAccountID": { "type": "integer", "format": "int64", "description": "Parent account ID. **REQUIRED** for `VIRTUAL` accounts.", "example": 8675309 }, "Partner": { "type": "object", "description": "Applicant's personal information", "properties": { "name": { "$ref": "#/components/schemas/IndividualsName" }, "nickname": { "$ref": "#/components/schemas/Nickname" }, "printed_name": { "$ref": "#/components/schemas/PrintedName" }, "social_name": { "$ref": "#/components/schemas/SocialName" }, "email": { "$ref": "#/components/schemas/IndividualsEmailAddress" }, "document_number": { "$ref": "#/components/schemas/DocumentNumber" }, "mothers_name": { "$ref": "#/components/schemas/MothersName" }, "gender": { "$ref": "#/components/schemas/Gender" }, "birth_date": { "$ref": "#/components/schemas/BirthDate" }, "city_of_birth": { "$ref": "#/components/schemas/CityOfBirth" }, "state_of_birth": { "$ref": "#/components/schemas/StateOfBirth" }, "country_of_birth": { "$ref": "#/components/schemas/CountryOfBirth" }, "fathers_name": { "$ref": "#/components/schemas/FathersName" }, "marital_status": { "$ref": "#/components/schemas/MaritalStatus" } } }, "PEP": { "type": "boolean", "description": "Is this person a Politically Exposed Person (PEP)? Pismo doesn't do anything differently for a PEP, this is just additional account information. Default is `false`.\n", "example": false }, "PercOwnership2": { "type": "integer", "format": "int64", "description": "Company percentage ownership", "example": 50 }, "PersonalExternalId": { "type": "string", "description": "Client-supplied personal ID from an external system or application.", "maxLength": 60, "example": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f" }, "PrintedName": { "type": "string", "description": "\nThis field is **DEPRECATED**. \n\nName to be printed on the card. \n\nPunctuation, special characters, and connectors (da/das/de/do/dos/e) are always removed. \n\nThis field's maximum length is 25, but you can set it to a lower value at the program level with the `Max name length on physical card` program parameter.\n\nIf `printed_name` is null, the Pismo platform uses `social_name`. If `social_name` is null, the Pismo platform uses the customer's entity name. For more information on the customer object, refer to [Core objects](https://developers.pismo.io/pismo-docs/docs/setup-overview#customer).\n\nThe Pismo platform gets the name for program parameter `TAMANHO MAX NOME EMBOSSADO` (max size name embossed).\n", "maxLength": 25, "deprecated": true, "example": "Jack Williams" }, "PrintedName2": { "type": "string", "description": "\nThis field is **DEPRECATED**. Cards is now responsible for this field.\n\nName to be printed on the card. **REQUIRED** if `name` and `social_name` are not provided.\n\nPunctuation, special characters, and connectors (da/das/de/do/dos/e) are always removed. \n\nThis field's maximum length is 25, but you can set it to a lower value at the program level with the `Max name length on physical card` program parameter.\n", "maxLength": 25, "deprecated": true, "example": "John Doe" }, "ProgramID": { "type": "integer", "format": "int64", "description": "Program ID", "example": 12345 }, "ProgramID2": { "type": "integer", "format": "int64", "description": "Program ID. **REQUIRED** when `acquisition_channel` is not passed.", "example": 111 }, "RegistrationNumber": { "type": "string", "description": "Company's registration number with local authorities", "maxLength": 30, "example": "ACM10004" }, "SimpleError": { "title": "SimpleError", "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Error message" } } }, "SocialName": { "type": "string", "description": "Social name.", "maxLength": 64, "example": "Jack" }, "SocialName2": { "type": "string", "description": "Social name. **REQUIRED** if `name` is not provided.", "maxLength": 64, "example": "Terminator" }, "State2": { "type": "string", "description": "Address state", "maxLength": 30, "example": "California" }, "StateOfBirth": { "type": "string", "description": "Birth state", "maxLength": 60, "example": "California" }, "Statutory": { "type": "boolean", "description": "Is person statutory? A statutory employee is defined as an employee by law under a specific statute. Pismo doesn't do anything differently in this case, it is simply additional account information. Default is `false`.\n", "example": false }, "Submit": { "type": "boolean", "description": "Should form be processed now (`true`), or later after adding more information (`false`).", "example": true }, "ZipCode2": { "type": "string", "description": "Zip/postal code", "maxLength": 16, "example": "12345-678" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "BearerAuth": [] } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true }, "paths": { "/acquisitions/v2/s2s/applications": { "post": { "summary": "Create account application (deprecated)", "description": "This endpoint is **DEPRECATED**. Use the new [Create account application](https://developers.pismo.io/pismo-docs/reference/post-acquisitions-v3-s2s-applications) instead.\n\nCreate a new account application. \n\nIf the `submit` property is set to `false`:\n- The application is not sent for processing and can be further PATCH-ed with incremental changes. \n- This endpoint generates an [Account application prospect created](https://developers.pismo.io/events/docs/onboarding-prospect-1) event.\n\nIf the `submit` flag is set to `true`:\n- No further updates can be made and the account application is sent out for processing, which creates an account and its associated structures.\n- This endpoint generates an [Account application created](https://developers.pismo.io/events/docs/onboarding-succeeded-1) event.\n", "operationId": "post-acquisitions-v2-s2s-applications", "deprecated": true, "tags": [ "Accounts" ], "parameters": [], "requestBody": { "description": "Application details", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "application": { "$ref": "#/components/schemas/AcquisitionRequestOutdated" } } }, "examples": { "Application Form": { "value": { "application": { "submit": true, "program_id": 1, "due_date": 123, "applicant": { "document_number": "228-88-7742", "personal": { "name": "John Doe", "email": "john.doe@email.com" }, "birth_date": "31/01/1980", "addresses": [ { "address": "228-88-7742", "number": "12A", "address1": "123", "neighborhood": "Faraway Creek", "complementary_address": "Apt. 10A", "city": "Smallville", "state": "KS", "country": "USA", "zip_code": "66080", "address_type": "RESIDENTIAL", "mailing_address": true, "phones": [ { "phone_type": "MOBILE", "phone": "555-1234", "area_code": 11, "country_code": 55 } ] } ], "account": { "external_id": "b9215aa7-4f88-4154-9d86-52b3662f28ac" } } } } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcquisitionResponse" }, "examples": { "Application created": { "value": { "application_id": 23942777, "status": 4, "status_name": "APPROVED", "account_id": 123, "customer_id": 456, "entity_id": 789, "program_id": 100 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountDuplicityByExternalIdError" }, "examples": { "Bad channel": { "value": { "message": "Invalid acquisition channel" } }, "Duplicity By External Id": { "value": { "message": "Account with same external id already registered", "org_id": "TN-34778262-f4f0-464d-b4c6-a14e2dc6f4be", "account_id": 123, "application_id": 23942777, "customer_id": 456, "entity_id": 789, "program_id": 100 } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" }, "examples": { "Account conflict": { "value": { "message": "Account already created" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleError" }, "examples": { "Internal server error": { "value": { "message": "Error registering application" } } } } } } } } } } } ```