# Update app

PUT https://api-sandbox.payabli.com/api/Boarding/app/{appId}
Content-Type: application/json

Updates a boarding application by ID. This endpoint requires an application API token.

Reference: https://docs.payabli.com/developers/api-reference/boarding/update-boarding-application

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Update boarding application
  version: endpoint_boarding.UpdateApplication
paths:
  /Boarding/app/{appId}:
    put:
      operationId: update-application
      summary: Update boarding application
      description: >-
        Updates a boarding application by ID. This endpoint requires an
        application API token.
      tags:
        - - subpackage_boarding
      parameters:
        - name: appId
          in: path
          description: 'Boarding application ID. '
          required: true
          schema:
            type: integer
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/type_:PayabliApiResponse00Responsedatanonobject
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_:ApplicationData'
components:
  schemas:
    type_:AchSetup:
      type: object
      properties:
        acceptCCD:
          type: boolean
          description: >-
            CCD is an ACH SEC Code that can be used in ACH transactions by the
            user that indicates the transaction is a Corporate Credit or Debit
            Entry. Options are: `true` and `false`
        acceptPPD:
          type: boolean
          description: >-
            PPD is an ACH SEC Code that can be used in ACH transactions by the
            user that indicates the transaction is a Prearranged Payment and
            Deposit.
        acceptWeb:
          type: boolean
          description: >-
            Web is an ACH SEC Code that can be used in ACH transactions by the
            user that indicates the transaction is a Internet Initiated/Mobile
            Entry Options are `true` and `false`.
    type_:CardSetup:
      type: object
      properties:
        acceptAmex:
          type: boolean
          description: Determines whether American Express is accepted.
        acceptDiscover:
          type: boolean
          description: Determines whether Discover is accepted.
        acceptMastercard:
          type: boolean
          description: Determines whether Mastercard is accepted.
        acceptVisa:
          type: boolean
          description: Determines whether Visa is accepted.
    type_:OdpSetupProcessingRegion:
      type: string
      enum:
        - value: US
        - value: CA
    type_:OdpSetup:
      type: object
      properties:
        allowAch:
          type: boolean
          description: Enables or disables ACH payout functionality
        allowChecks:
          type: boolean
          description: Enables or disables check printing payout functionality
        allowVCard:
          type: boolean
          description: Enables or disables vCard payout functionality
        processing_region:
          $ref: '#/components/schemas/type_:OdpSetupProcessingRegion'
          description: Region where payment processing occurs
        processor:
          type: string
          description: Payment processor identifier
        issuerNetworkSettingsId:
          type: string
          description: Reference ID for the program enabled for ODP issuance
    type_:Services:
      type: object
      properties:
        ach:
          $ref: '#/components/schemas/type_:AchSetup'
        card:
          $ref: '#/components/schemas/type_:CardSetup'
        odp:
          $ref: '#/components/schemas/type_:OdpSetup'
    type_:Annualrevenue:
      type: number
      format: double
    type_:FileContentFtype:
      type: string
      enum:
        - value: pdf
        - value: doc
        - value: docx
        - value: jpg
        - value: jpeg
        - value: png
        - value: gif
        - value: txt
    type_:FileContent:
      type: object
      properties:
        fContent:
          type: string
          description: >-
            Content of file, Base64-encoded. Ignored if furl is specified. Max
            upload size is 30 MB.
        filename:
          type: string
          description: The name of the attached file.
        ftype:
          $ref: '#/components/schemas/type_:FileContentFtype'
          description: The MIME type of the file (if content is provided)
        furl:
          type: string
          description: Optional URL provided to show or download the file remotely
    type_:Attachments:
      type: array
      items:
        $ref: '#/components/schemas/type_:FileContent'
    type_:Avgmonthly:
      type: number
      format: double
    type_:Baddress1:
      type: string
    type_:Baddress2:
      type: string
    type_:BankNickname:
      type: string
    type_:BankName:
      type: string
    type_:RoutingAccount:
      type: string
    type_:AccountNumber:
      type: string
    type_:TypeAccount:
      type: string
      enum:
        - value: Checking
        - value: Savings
    type_:BankAccountHolderName:
      type: string
    type_:BankAccountHolderType:
      type: string
      enum:
        - value: Personal
        - value: Business
    type_:BankAccountFunction:
      type: integer
    type_:Bank:
      type: object
      properties:
        id:
          type: integer
          description: The Payabli-assigned internal identifier for the bank account.
        accountId:
          type: string
          description: >-
            A user-defined internal identifier for the bank account. This allows
            you to specify which bank account should be used for payments in
            cases where multiple accounts are configured.
        nickname:
          $ref: '#/components/schemas/type_:BankNickname'
        bankName:
          $ref: '#/components/schemas/type_:BankName'
        routingAccount:
          $ref: '#/components/schemas/type_:RoutingAccount'
        accountNumber:
          $ref: '#/components/schemas/type_:AccountNumber'
        typeAccount:
          $ref: '#/components/schemas/type_:TypeAccount'
        bankAccountHolderName:
          $ref: '#/components/schemas/type_:BankAccountHolderName'
        bankAccountHolderType:
          $ref: '#/components/schemas/type_:BankAccountHolderType'
        bankAccountFunction:
          $ref: '#/components/schemas/type_:BankAccountFunction'
        verified:
          type: boolean
          description: >-
            Bank account verification status. When `true`, the account has been
            verified to exist and be in good standing based on vendor checks or
            previous processing histories.
        status:
          type: integer
          description: Bank account status
        services:
          type: array
          items:
            type: string
          description: Array of services associated with this bank account
    type_:Bcity:
      type: string
    type_:Bcountry:
      type: string
    type_:Binperson:
      type: integer
    type_:Binphone:
      type: integer
    type_:Binweb:
      type: integer
    type_:Bstate:
      type: string
    type_:Bsummary:
      type: string
    type_:OwnType:
      type: string
      enum:
        - value: Limited Liability Company
        - value: Non-Profit Org
        - value: Partnership
        - value: Private Corp
        - value: Public Corp
        - value: Tax Exempt
        - value: Government
        - value: Sole Proprietor
    type_:Bzip:
      type: string
    type_:Email:
      type: string
      format: email
    type_:AdditionalDataString:
      type: string
    type_:Contacts:
      type: object
      properties:
        contactEmail:
          $ref: '#/components/schemas/type_:Email'
          description: Contact email address.
        contactName:
          type: string
          description: Contact name.
        contactPhone:
          type: string
          description: Contact phone number.
        contactTitle:
          type: string
          description: Contact title.
        additionalData:
          $ref: '#/components/schemas/type_:AdditionalDataString'
    type_:ContactsField:
      type: array
      items:
        $ref: '#/components/schemas/type_:Contacts'
    type_:Dbaname:
      type: string
    type_:Ein:
      type: string
    type_:ExternalPaypointId:
      type: string
    type_:BoardingBusinessFax:
      type: string
    type_:Highticketamt:
      type: number
      format: double
    type_:Legalname:
      type: string
    type_:License:
      type: string
    type_:Licensestate:
      type: string
    type_:Maddress:
      type: string
    type_:Maddress1:
      type: string
    type_:Mcc:
      type: string
    type_:Mcity:
      type: string
    type_:Mcountry:
      type: string
    type_:Mstate:
      type: string
    type_:Mzip:
      type: string
    type_:Orgid:
      type: integer
      format: int64
    type_:Owners:
      type: object
      properties:
        ownername:
          type: string
          description: >-
            Person who is registered as the beneficial owner of the business.
            This is a combination of first and last name.
        ownertitle:
          type: string
          description: The job title of the person such as CEO or director.
        ownerpercent:
          type: integer
          description: Percentage of ownership the person holds, in integer format.
        ownerssn:
          type: string
          description: >-
            The relevant identifier for the person such as a Social Security
            Number.
        ownerdob:
          type: string
          description: Owner's date of birth.
        ownerphone1:
          type: string
          description: Owner phone 1.
        ownerphone2:
          type: string
          description: Owner phone 2.
        owneremail:
          $ref: '#/components/schemas/type_:Email'
          description: Owner email.
        ownerdriver:
          type: string
          description: >-
            Owner driver's license ID number. Payabli strongly recommends
            including this.
        oaddress:
          type: string
          description: >-
            Owner street address. This must be the physical address of the
            owner, not a P.O. box.
        ocity:
          type: string
          description: Owner address city.
        ocountry:
          type: string
          description: >-
            Owner address country in ISO-3166-1 alpha 2 format. Check out
            https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
        odriverstate:
          type: string
          description: >-
            Owner driver's license State. Payabli strongly recommends including
            this.
        ostate:
          type: string
          description: Owner address state.
        ozip:
          type: string
          description: Owner address ZIP.
        additionalData:
          $ref: '#/components/schemas/type_:AdditionalDataString'
    type_:Ownership:
      type: array
      items:
        $ref: '#/components/schemas/type_:Owners'
    type_:PayoutAverageMonthlyVolume:
      type: number
      format: double
    type_:PayoutAverageTicketLimit:
      type: number
      format: double
    type_:PayoutCreditLimit:
      type: number
      format: double
    type_:PayoutHighTicketAmount:
      type: number
      format: double
    type_:BoardingBusinessPhone:
      type: string
    type_:RecipientEmailNotification:
      type: boolean
    type_:Resumable:
      type: boolean
    type_:SignerName:
      type: string
    type_:SignerSsn:
      type: string
    type_:SignerDob:
      type: string
    type_:SignerPhone:
      type: string
    type_:Signeraddress:
      type: string
    type_:SignerAddress1:
      type: string
    type_:SignerCity:
      type: string
    type_:SignerCountry:
      type: string
    type_:SignerState:
      type: string
    type_:SignerZip:
      type: string
    type_:SignerAcceptance:
      type: boolean
    type_:SignedDocumentReference:
      type: string
    type_:PciAttestation:
      type: boolean
    type_:AttestationDate:
      type: string
    type_:SignDate:
      type: string
    type_:SignerDataRequest:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/type_:SignerName'
        ssn:
          $ref: '#/components/schemas/type_:SignerSsn'
        dob:
          $ref: '#/components/schemas/type_:SignerDob'
        phone:
          $ref: '#/components/schemas/type_:SignerPhone'
        email:
          $ref: '#/components/schemas/type_:Email'
          description: The signer's email address.
        address:
          $ref: '#/components/schemas/type_:Signeraddress'
        address1:
          $ref: '#/components/schemas/type_:SignerAddress1'
        city:
          $ref: '#/components/schemas/type_:SignerCity'
        country:
          $ref: '#/components/schemas/type_:SignerCountry'
        state:
          $ref: '#/components/schemas/type_:SignerState'
        zip:
          $ref: '#/components/schemas/type_:SignerZip'
        acceptance:
          $ref: '#/components/schemas/type_:SignerAcceptance'
        signedDocumentReference:
          $ref: '#/components/schemas/type_:SignedDocumentReference'
        pciAttestation:
          $ref: '#/components/schemas/type_:PciAttestation'
        attestationDate:
          $ref: '#/components/schemas/type_:AttestationDate'
        additionalData:
          $ref: '#/components/schemas/type_:AdditionalDataString'
        signDate:
          $ref: '#/components/schemas/type_:SignDate'
    type_:Busstartdate:
      type: string
    type_:Taxfillname:
      type: string
    type_:TemplateId:
      type: integer
      format: int64
    type_:Ticketamt:
      type: number
      format: double
    type_:Website:
      type: string
    type_:Whencharged:
      type: string
      enum:
        - value: When Service Provided
        - value: In Advance
    type_:Whendelivered:
      type: string
      enum:
        - value: 0-7 Days
        - value: 8-14 Days
        - value: 15-30 Days
        - value: Over 30 Days
    type_:Whenprovided:
      type: string
      enum:
        - value: 30 Days or Less
        - value: 31 to 60 Days
        - value: 60+ Days
    type_:Whenrefunded:
      type: string
      enum:
        - value: Exchange Only
        - value: No Refund or Exchange
        - value: More than 30 days
        - value: 30 Days or Less
    type_:RepCode:
      type: string
    type_:RepName:
      type: string
    type_:RepOffice:
      type: string
    type_:OnCreate:
      type: string
    type_:ApplicationData:
      type: object
      properties:
        services:
          $ref: '#/components/schemas/type_:Services'
        annualRevenue:
          $ref: '#/components/schemas/type_:Annualrevenue'
        attachments:
          $ref: '#/components/schemas/type_:Attachments'
        avgmonthly:
          $ref: '#/components/schemas/type_:Avgmonthly'
        baddress:
          $ref: '#/components/schemas/type_:Baddress1'
        baddress1:
          $ref: '#/components/schemas/type_:Baddress2'
        bankData:
          $ref: '#/components/schemas/type_:Bank'
        bcity:
          $ref: '#/components/schemas/type_:Bcity'
        bcountry:
          $ref: '#/components/schemas/type_:Bcountry'
        binperson:
          $ref: '#/components/schemas/type_:Binperson'
        binphone:
          $ref: '#/components/schemas/type_:Binphone'
        binweb:
          $ref: '#/components/schemas/type_:Binweb'
        bstate:
          $ref: '#/components/schemas/type_:Bstate'
        bsummary:
          $ref: '#/components/schemas/type_:Bsummary'
        btype:
          $ref: '#/components/schemas/type_:OwnType'
        bzip:
          $ref: '#/components/schemas/type_:Bzip'
        contacts:
          $ref: '#/components/schemas/type_:ContactsField'
        dbaname:
          $ref: '#/components/schemas/type_:Dbaname'
        ein:
          $ref: '#/components/schemas/type_:Ein'
        externalPaypointId:
          $ref: '#/components/schemas/type_:ExternalPaypointId'
        faxnumber:
          $ref: '#/components/schemas/type_:BoardingBusinessFax'
        highticketamt:
          $ref: '#/components/schemas/type_:Highticketamt'
        legalname:
          $ref: '#/components/schemas/type_:Legalname'
        license:
          $ref: '#/components/schemas/type_:License'
        licstate:
          $ref: '#/components/schemas/type_:Licensestate'
        maddress:
          $ref: '#/components/schemas/type_:Maddress'
        maddress1:
          $ref: '#/components/schemas/type_:Maddress1'
        mcc:
          $ref: '#/components/schemas/type_:Mcc'
        mcity:
          $ref: '#/components/schemas/type_:Mcity'
        mcountry:
          $ref: '#/components/schemas/type_:Mcountry'
        mstate:
          $ref: '#/components/schemas/type_:Mstate'
        mzip:
          $ref: '#/components/schemas/type_:Mzip'
        orgId:
          $ref: '#/components/schemas/type_:Orgid'
        ownership:
          $ref: '#/components/schemas/type_:Ownership'
        payoutAverageMonthlyVolume:
          $ref: '#/components/schemas/type_:PayoutAverageMonthlyVolume'
        payoutAverageTicketLimit:
          $ref: '#/components/schemas/type_:PayoutAverageTicketLimit'
        payoutCreditLimit:
          $ref: '#/components/schemas/type_:PayoutCreditLimit'
        payoutHighTicketAmount:
          $ref: '#/components/schemas/type_:PayoutHighTicketAmount'
        phonenumber:
          $ref: '#/components/schemas/type_:BoardingBusinessPhone'
        recipientEmail:
          $ref: '#/components/schemas/type_:Email'
          description: >-
            Email address for the applicant. This is used to send the applicant
            a boarding link.
        recipientEmailNotification:
          $ref: '#/components/schemas/type_:RecipientEmailNotification'
        resumable:
          $ref: '#/components/schemas/type_:Resumable'
        signer:
          $ref: '#/components/schemas/type_:SignerDataRequest'
        startdate:
          $ref: '#/components/schemas/type_:Busstartdate'
        taxfillname:
          $ref: '#/components/schemas/type_:Taxfillname'
        templateId:
          $ref: '#/components/schemas/type_:TemplateId'
        ticketamt:
          $ref: '#/components/schemas/type_:Ticketamt'
        website:
          $ref: '#/components/schemas/type_:Website'
        whenCharged:
          $ref: '#/components/schemas/type_:Whencharged'
        whenDelivered:
          $ref: '#/components/schemas/type_:Whendelivered'
        whenProvided:
          $ref: '#/components/schemas/type_:Whenprovided'
        whenRefunded:
          $ref: '#/components/schemas/type_:Whenrefunded'
        RepCode:
          $ref: '#/components/schemas/type_:RepCode'
        RepName:
          $ref: '#/components/schemas/type_:RepName'
        RepOffice:
          $ref: '#/components/schemas/type_:RepOffice'
        onCreate:
          $ref: '#/components/schemas/type_:OnCreate'
    type_:Responsecode:
      type: integer
    type_:PageIdentifier:
      type: string
    type_:IsSuccess:
      type: boolean
    type_:ResponseText:
      type: string
    type_:Responsedatanonobject:
      oneOf:
        - type: string
        - type: integer
    type_:PayabliApiResponse00Responsedatanonobject:
      type: object
      properties:
        responseCode:
          $ref: '#/components/schemas/type_:Responsecode'
        pageIdentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
        roomId:
          type: integer
          format: int64
          description: >-
            Describes the room ID. Only in use on Boarding endpoints, returns
            `0` when not applicable.
        isSuccess:
          $ref: '#/components/schemas/type_:IsSuccess'
        responseText:
          $ref: '#/components/schemas/type_:ResponseText'
        responseData:
          $ref: '#/components/schemas/type_:Responsedatanonobject'
      required:
        - responseText

```

## SDK Code Examples

```typescript General success response example for some boarding operations.
import { PayabliClient, PayabliEnvironment } from "@payabli/sdk-node";

async function main() {
    const client = new PayabliClient({
        environment: PayabliEnvironment.Sandbox,
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.boarding.updateApplication(352, {});
}
main();

```

```python General success response example for some boarding operations.
from payabli import payabli
from payabli.environment import payabliEnvironment

client = payabli(
    environment=payabliEnvironment.SANDBOX,
    api_key="YOUR_API_KEY_HERE"
)

client.boarding.update_application(
    app_id=352
)

```

```csharp General success response example for some boarding operations.
using PayabliApi;
using System.Threading.Tasks;

namespace Usage;

public class Example
{
    public async Task Do() {
        var client = new PayabliApiClient(
            apiKey: "YOUR_API_KEY_HERE",
            clientOptions: new ClientOptions {
                BaseUrl = PayabliApiEnvironment.Sandbox
            }
        );

        await client.Boarding.UpdateApplicationAsync(
            352,
            new ApplicationData()
        );
    }

}

```

```go General success response example for some boarding operations.
package example

import (
    client "github.com/payabli/sdk-go/v/client"
    option "github.com/payabli/sdk-go/v/option"
    payabli "github.com/payabli/sdk-go/v"
    context "context"
)

func do() {
    client := client.NewClient(
        option.WithBaseURL(
            payabli.Environments.Sandbox,
        ),
        option.WithApiKey(
            "YOUR_API_KEY_HERE",
        ),
    )
    request := &payabli.ApplicationData{}
    client.Boarding.UpdateApplication(
        context.TODO(),
        352,
        request,
    )
}

```

```ruby General success response example for some boarding operations.
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Boarding/app/352")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["requestToken"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java General success response example for some boarding operations.
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api-sandbox.payabli.com/api/Boarding/app/352")
  .header("requestToken", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php General success response example for some boarding operations.
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api-sandbox.payabli.com/api/Boarding/app/352', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift General success response example for some boarding operations.
import Foundation

let headers = [
  "requestToken": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Boarding/app/352")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```