--- title: "Update account application" method: PATCH path: "/acquisitions/v2/s2s/applications/{applicationId}" tags: ["Accounts"] --- # Update account application `PATCH /acquisitions/v2/s2s/applications/{applicationId}` Update a previously-created account application, only if the account application's `submit` field is `false`. If `submit` is set to `false`: - The application is not sent for processing and can be further modified with incremental changes via this endpoint. If `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. **Warning**—Some of the account's elements are created asynchronously and you should refrain from accessing the account via other endpoints until the events this endpoint generates are received. **Notes:** * By default, `prospect_cancel` is `false`. If you set `prospect_cancel` to `true`, the account application is canceled and no further updates can be made. * You **cannot** update a previously-entered address. All addresses entered are considered new. The main address is the last one passed with `mailing_address` = `true`. * You **cannot** update a previously-entered `partner` object. All partner information entered is considered new. * For all other objects and fields, anything not passed is not updated. ## Path parameters - `applicationId` integer, required ## Request body - object - `application` AcquisitionRequestUpdate — Application form - `submit` boolean — Should form be processed now (`true`), or later after adding more information (`false`). - `prospect_cancel` boolean — Should prospect be canceled (`true`), or can more information be added later (`false`). - `applicant` Applicant2 — Applicant's details - `document_number` string, required — Applicant's document number (such as a government tax ID). For a company, this can be something like its tax or business registration number. **Important**: Once passed, this value **CANNOT** be changed, even if `submit` is `false`. - `birth_date` string — Birth date. Format = dd/mm/yyyy. - `personal` ApplicantPersonal — Applicant's personal information. Either this or the `company` object is **REQUIRED**. Pass one or the other but not both. - `external_id` string — Client-supplied personal ID from an external system or application. - `name` string — Name. **REQUIRED** if `social_name` is not provided. - `email` string, email — Email address. - `gender` 'F' | 'M' | '' — Gender - `printed_name` string — This field is **DEPRECATED**. Cards is now responsible for this field. Name to be printed on the card. **REQUIRED** if `name` and `social_name` are not provided. Punctuation, special characters, and connectors (da/das/de/do/dos/e) are always removed. This 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. - `nickname` string — Nickname. - `social_name` string — Social name. **REQUIRED** if `name` is not provided. - `country_of_birth` string — Birth country - `state_of_birth` string — Birth state - `city_of_birth` string — Birth city - `registration` ApplicantRegistration — Applicant's document information - `number` string — Document number, such as a tax ID. - `education_degree` string — Education degree - `marital_status` 'SINGLE' | 'MARRIED' | 'DIVORCED' | 'WIDOWER' — Marital status - `fathers_name` string — Father's name - `mothers_name` string — Mother's name - `nationality` string — Nationality - `other_id_number` string — Another ID number - `document_type` string — Document type. Free-form field, not an enum. - `document_issued_by` string — Document issuer - `document_issued_at` string — Document issuer location. This is a free-form field, not an ISO standard. - `document_issued_date` string — Date document was issued. Format = dd/mm/yyyy. - `occupation` string — Applicant's occupation - `assets` number, float — Assets - `income` integer — Applicant's income - `net_worth` integer — Applicant's net worth - `pep` boolean — 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`. - `statutory` boolean — 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`. - `company` ApplicantCompany — Applicant's company information. Either this or the `personal` object is **REQUIRED**. Pass one or the other but not both. - `external_id` string — Client-provided company ID from an external system. - `name` string, required — Company's legal name - `email` string — Company's registered email - `company_name` string — Company's brand name - `registration_number` string — Company's registration number with local authorities - `activity` string — Company's general field of activity - `company_type` string — Company type - `company_format` string — Company social type - `company_constitution_date` string, date — Company's operational start date. Format = yyyy-mm-dd. - `occupation` string — Company's main occupation - `income` integer — Company's income - `net_worth` integer — Company's net worth - `annual_revenues` integer — Average monthly revenue for the last 12 months - `type` string — Company's business relations type - `number_of_partners` integer — Number of company partners - `perc_ownership` integer — Company percentage ownership - `fiscal_situation` string — Company's fiscal situation. - `debt` integer — Company's debt - `partners` Partner[] — Company partners - `name` string — Name - `nickname` string — Nickname. - `printed_name` string — Printed name on physical card - `social_name` string — Social name. - `email` string, email — Email address. - `document_number` string — Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license. - `mothers_name` string — Mother's name - `gender` 'F' | 'M' | '' — Gender - `birth_date` string — Birth date. Format = dd/mm/yyyy. - `city_of_birth` string — Birth city - `state_of_birth` string — Birth state - `country_of_birth` string — Birth country - `fathers_name` string — Father's name - `marital_status` 'SINGLE' | 'MARRIED' | 'DIVORCED' | 'WIDOWER' — Marital status - `account` ApplicantAccount — Applicant's account options - `currency_numeric_code` string — Numeric code (ISO 4217) for the currency used by the program.
`minLength: 3` `maxLength: 3` - `granted_limit` integer — Account's credit limit. **REQUIRED** for credit programs. This 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. - `limit` integer — Client-defined account limit. Must be between 0 and the `granted_limit` (aka `max_credit_limit`). Defaults to zero (0) if not passed. 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. - `exchange_mode` 'SAME_DAY' | 'CLOSING' — When a foreign transaction is charged the exchange rate: * `SAME_DAY` - Day the transaction occurred * `CLOSING` - Statement's closing date This field is valid for credit [programs](https://developers.pismo.io/pismo-docs/docs/program-types) **only**. - `external_id` string — Client-created ID from an external system or application. **REQUIRED** for `VIRTUAL` accounts. - `parent_account_id` integer — Parent account ID. If provided, the account is the child of the account referenced by `parent_account_id`. The account referenced by `parent_account_id` can be in another program or division. - `overdraft_limit` number, float — Account overdraft limit
`minimum: 0` `maximum: 18446744073709551617` - `account_type` 'CACC' | 'SLRY' | 'SVGS' | 'TRAN' — Account type:
`CACC` - Checking/current account. Known as "conta corrente" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking.
`SVGS` - Savings account
`TRAN` - Payment account. Payment institutions offer payment accounts to move funds and make payments, while banks offer checking accounts that include full financial services such as credit and investments.
`SLRY` - Salary account. Employer deposits a fixed amount every month.
- `division_id` string, uuid — Pismo generates the division ID when you use the [Create division](https://developers.pismo.io/pismo-docs/reference/post-division-v2) endpoint. - `centralizer` boolean — Is this a centralizer account? A centralizer account, within the account hierarchy, is the account responsible for invoice billing. Defaults to `false`. - `addresses` object[] — List of addresses - `address` Address, required - `line1` string — Address line one - `line2` string — Address line two - `country` string, required — Billing address country - ISO-3166-1 3-letter code. - `country_subdivision` string — Country subdivision such as state or sultanate - `city` string — Billing address city - `postal_code` string — Billing address postal code, such as zip code in the United States. - `number` string — Address number as string or integer. If you enter numeric characters, they are saved in the `number` address object field. If you enter any non-numeric characters, all characters are saved in the `extended_number` address object field. For example, if you enter "12 A", it gets saved as follows: * `number` = 12 * `extended_number` = "12 A" - `city` string, required — Address city - `state` string, required — Address state - `country` string, required — Address country - `address_type` 'RESIDENTIAL' | 'COMMERCIAL' | 'OTHER', required — Address type - `zip_code` string, required — Zip/postal code - `neighborhood` string, required — Address neighborhood. Some countries use neighborhood in addresses. - `complementary_address` string — Any additional information such as suite, apt., and so on. - `mailing_address` boolean — Is this address the mailing address? Only one address can have this field set to `true`. - `custom_fields` CustomFields — Name-value fields for any account-related data your organization needs to store at Pismo. This field can have its values validated against the JSON schema stored at the division (referenced by the `division_code`) field `schema`. - `custom_fields` CustomFields — Name-value fields for any account-related data your organization needs to store at Pismo. This field can have its values validated against the JSON schema stored at the division (referenced by the `division_code`) field `schema`. ## Response `200` OK - AcquisitionResponse — Aquisition form was successfully created. - `application_id` integer, required — Application form ID (non-checking accounts only) - `status` integer, required — Application status ID - `status_name` string, required — Application status. Most likely to be * `REGISTERED` - Application was saved, but not started processing yet. * `APPROVED` - Application has finished processing. * `PROSPECT` - Application was created with `submit` = `false`. - `account_id` integer, required — Created account ID. `null` if the application has not been proccessed yet (non-checking accounts only). - `customer_id` integer, required — Created customer ID. `null` if the application has not yet been proccessed (non-checking accounts only). - `entity_id` integer, required — Created entity ID. `null` if the application has not yet been proccessed (non-checking accounts only). - `program_id` number, required — Pismo program ID. ## Other responses - `400` — Bad request - `409` — Conflict - `500` — Internal server error --- [API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/revisions/935b62e16de4/schema)