# Get app by ID GET https://api-sandbox.payabli.com/api/Boarding/read/{appId} Retrieves the details for a boarding application by ID. Reference: https://docs.payabli.com/developers/api-reference/boarding/get-boarding-application-by-id ## OpenAPI Specification ```yaml openapi: 3.1.1 info: title: Get boarding application by ID version: endpoint_boarding.GetApplication paths: /Boarding/read/{appId}: get: operationId: get-application summary: Get boarding application by ID description: 'Retrieves the details for a boarding application by ID. ' 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_:ApplicationDetailsRecord' '400': description: Bad request/ invalid data content: {} '401': description: Unauthorized request. content: {} '500': description: Internal API Error content: {} '503': description: Database connection error content: {} components: schemas: type_:Annualrevenue: type: number format: double type_:Avgmonthly: type: number format: double type_:Ticketamt: 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_:BankData: type: array items: $ref: '#/components/schemas/type_:Bank' type_:Bcity: type: string type_:Bcountry: type: string type_:Bphone: type: string type_:Binperson: type: integer type_:Binphone: type: integer type_:Binweb: type: integer type_:BoardingLinkId: type: integer type_:BoardingStatus: type: integer type_:Busstartdate: type: string type_:Bstate: type: string type_:Bsummary: type: string type_:ReadOnly: type: boolean type_:RequiredElement: type: boolean type_:ValueTemplates: type: string type_:LinkData: type: object properties: ro: $ref: '#/components/schemas/type_:ReadOnly' rq: $ref: '#/components/schemas/type_:RequiredElement' validator: type: string description: |- The type of validation applied to the field. Available values: - text - alpha - ein - url - phone - alphanumeric - zipcode - numbers - float - ssn - email - routing value: $ref: '#/components/schemas/type_:ValueTemplates' type_:AchLinkTypes: type: object properties: ccd: $ref: '#/components/schemas/type_:LinkData' ppd: $ref: '#/components/schemas/type_:LinkData' web: $ref: '#/components/schemas/type_:LinkData' type_:LinkRow: type: object properties: columns: type: array items: $ref: '#/components/schemas/type_:LinkData' type_:BasicTable: type: object properties: body: type: array items: $ref: '#/components/schemas/type_:LinkRow' header: $ref: '#/components/schemas/type_:LinkRow' type_:AchSection: type: object properties: acceptance: $ref: '#/components/schemas/type_:AchLinkTypes' fees: $ref: '#/components/schemas/type_:BasicTable' price: $ref: '#/components/schemas/type_:BasicTable' type_:CardLinkTypes: type: object properties: amex: $ref: '#/components/schemas/type_:LinkData' discover: $ref: '#/components/schemas/type_:LinkData' mastercard: $ref: '#/components/schemas/type_:LinkData' visa: $ref: '#/components/schemas/type_:LinkData' type_:CardSection: type: object properties: acceptance: $ref: '#/components/schemas/type_:CardLinkTypes' fees: $ref: '#/components/schemas/type_:BasicTable' price: $ref: '#/components/schemas/type_:BasicTable' type_:SSection: type: object properties: ach: $ref: '#/components/schemas/type_:AchSection' card: $ref: '#/components/schemas/type_:CardSection' type_:ASection: type: object properties: minimumDocuments: type: integer multipleContacts: type: boolean multipleOwners: type: boolean type_:Bnk: type: object properties: accountNumber: $ref: '#/components/schemas/type_:LinkData' bankName: $ref: '#/components/schemas/type_:LinkData' routingAccount: $ref: '#/components/schemas/type_:LinkData' typeAccount: $ref: '#/components/schemas/type_:LinkData' type_:DSection: type: object properties: depositAccount: $ref: '#/components/schemas/type_:Bnk' withdrawalAccount: $ref: '#/components/schemas/type_:Bnk' type_:BAddress: type: object properties: baddress: $ref: '#/components/schemas/type_:LinkData' baddress1: $ref: '#/components/schemas/type_:LinkData' bcity: $ref: '#/components/schemas/type_:LinkData' bcountry: $ref: '#/components/schemas/type_:LinkData' bstate: $ref: '#/components/schemas/type_:LinkData' bzip: $ref: '#/components/schemas/type_:LinkData' maddress: $ref: '#/components/schemas/type_:LinkData' maddress1: $ref: '#/components/schemas/type_:LinkData' mcity: $ref: '#/components/schemas/type_:LinkData' mcountry: $ref: '#/components/schemas/type_:LinkData' mstate: $ref: '#/components/schemas/type_:LinkData' mzip: $ref: '#/components/schemas/type_:LinkData' type_:BDetails: type: object properties: btype: $ref: '#/components/schemas/type_:LinkData' dbaname: $ref: '#/components/schemas/type_:LinkData' ein: $ref: '#/components/schemas/type_:LinkData' faxnumber: $ref: '#/components/schemas/type_:LinkData' legalname: $ref: '#/components/schemas/type_:LinkData' license: $ref: '#/components/schemas/type_:LinkData' licstate: $ref: '#/components/schemas/type_:LinkData' phonenumber: $ref: '#/components/schemas/type_:LinkData' startdate: $ref: '#/components/schemas/type_:LinkData' taxfillname: $ref: '#/components/schemas/type_:LinkData' website: $ref: '#/components/schemas/type_:LinkData' type_:BSection: type: object properties: address: $ref: '#/components/schemas/type_:BAddress' details: $ref: '#/components/schemas/type_:BDetails' type_:CList: type: object properties: contactEmail: $ref: '#/components/schemas/type_:LinkData' contactName: $ref: '#/components/schemas/type_:LinkData' contactPhone: $ref: '#/components/schemas/type_:LinkData' contactTitle: $ref: '#/components/schemas/type_:LinkData' type_:OList: type: object properties: oaddress: $ref: '#/components/schemas/type_:LinkData' ocity: $ref: '#/components/schemas/type_:LinkData' ocountry: $ref: '#/components/schemas/type_:LinkData' odriverstate: $ref: '#/components/schemas/type_:LinkData' ostate: $ref: '#/components/schemas/type_:LinkData' ownerdob: $ref: '#/components/schemas/type_:LinkData' ownerdriver: $ref: '#/components/schemas/type_:LinkData' owneremail: $ref: '#/components/schemas/type_:LinkData' ownername: $ref: '#/components/schemas/type_:LinkData' ownerpercent: $ref: '#/components/schemas/type_:LinkData' ownerphone1: $ref: '#/components/schemas/type_:LinkData' ownerphone2: $ref: '#/components/schemas/type_:LinkData' ownerssn: $ref: '#/components/schemas/type_:LinkData' ownertitle: $ref: '#/components/schemas/type_:LinkData' ozip: $ref: '#/components/schemas/type_:LinkData' type_:OSection: type: object properties: contact_list: $ref: '#/components/schemas/type_:CList' own_list: $ref: '#/components/schemas/type_:OList' type_:PSection: type: object properties: avgmonthly: $ref: '#/components/schemas/type_:LinkData' binperson: $ref: '#/components/schemas/type_:LinkData' binphone: $ref: '#/components/schemas/type_:LinkData' binweb: $ref: '#/components/schemas/type_:LinkData' bsummary: $ref: '#/components/schemas/type_:LinkData' highticketamt: $ref: '#/components/schemas/type_:LinkData' mcc: $ref: '#/components/schemas/type_:LinkData' ticketamt: $ref: '#/components/schemas/type_:LinkData' whenCharged: $ref: '#/components/schemas/type_:LinkData' whenDelivered: $ref: '#/components/schemas/type_:LinkData' whenProvided: $ref: '#/components/schemas/type_:LinkData' whenRefunded: $ref: '#/components/schemas/type_:LinkData' type_:BuilderData: type: object properties: services: $ref: '#/components/schemas/type_:SSection' attributes: $ref: '#/components/schemas/type_:ASection' banking: $ref: '#/components/schemas/type_:DSection' business: $ref: '#/components/schemas/type_:BSection' owners: $ref: '#/components/schemas/type_:OSection' processing: $ref: '#/components/schemas/type_:PSection' 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_:CreatedAt: type: string format: date-time type_:Dbaname: type: string type_:PairFiles: type: object properties: originalName: type: string description: Original filename zipName: type: string description: >- Filename assigned to zipped file. This is the name to use for reference in the API functions to get files in attachments. descriptor: type: string description: Descriptor of the file. type_:BoardingApplicationAttachments: type: object properties: filelist: type: array items: $ref: '#/components/schemas/type_:PairFiles' description: Array of objects describing files contained in the ZIP file. zipfile: type: string description: Zip file containing attachments. type_:Ein: type: string type_:ExternalPaypointId: type: string type_:Source: type: string type_:GeneralEvents: type: object properties: description: type: string description: Event description. eventTime: type: string format: date-time description: Event timestamp, in UTC. extraData: type: object additionalProperties: description: Any type description: Extra data. refData: type: string description: Reference data. source: $ref: '#/components/schemas/type_:Source' description: The event source. type_:Highticketamt: type: number format: double type_:AppId: type: integer type_:LastModified: type: string format: date-time type_:Legalname: type: string type_:License: type: string type_:Licensestate: type: string type_:Maddress: type: string type_:Maddress1: type: string type_:Mstate: type: string type_:Mcountry: type: string type_:ApplicationDetailsRecordMessagesItem: type: object properties: content: type: string createdAt: $ref: '#/components/schemas/type_:CreatedAt' currentApplicationStatus: type: integer currentApplicationSubStatus: type: integer id: type: integer messageType: type: integer originalApplicationStatus: type: integer originalApplicationSubStatus: type: integer roomId: type: integer userId: type: integer userName: type: string type_:Mzip: type: string type_:Orgid: type: integer format: int64 type_:OrgParentName: type: string 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_: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_:PageIdentifier: type: string type_:RecipientEmailNotification: type: boolean type_:Resumable: type: boolean type_:SalesCode: type: string 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_: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_:SignerState: type: string type_:SignerZip: type: string type_:SignerCountry: type: string type_:SignerAcceptance: type: boolean type_:PciAttestation: type: boolean type_:AttestationDate: type: string type_:SignDate: type: string type_:SignerData: type: object properties: signerUuid: type: string description: The signer's ID. This is automatically generated by Payabli. 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' state: $ref: '#/components/schemas/type_:SignerState' zip: $ref: '#/components/schemas/type_:SignerZip' country: $ref: '#/components/schemas/type_:SignerCountry' acceptance: $ref: '#/components/schemas/type_:SignerAcceptance' signedDocumentReference: type: string description: Reference to the signed document. pciAttestation: $ref: '#/components/schemas/type_:PciAttestation' attestationDate: $ref: '#/components/schemas/type_:AttestationDate' signDate: $ref: '#/components/schemas/type_:SignDate' additionalData: $ref: '#/components/schemas/type_:AdditionalDataString' type_:Taxfillname: type: string type_:TemplateId: type: integer format: int64 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_:ApplicationDetailsRecord: type: object properties: annualRevenue: $ref: '#/components/schemas/type_:Annualrevenue' averageMonthlyVolume: $ref: '#/components/schemas/type_:Avgmonthly' averageTicketAmount: $ref: '#/components/schemas/type_:Ticketamt' bAddress1: $ref: '#/components/schemas/type_:Baddress1' bAddress2: $ref: '#/components/schemas/type_:Baddress2' bankData: $ref: '#/components/schemas/type_:BankData' bCity: $ref: '#/components/schemas/type_:Bcity' bCountry: $ref: '#/components/schemas/type_:Bcountry' bFax: $ref: '#/components/schemas/type_:Bphone' description: The business's fax number. binPerson: $ref: '#/components/schemas/type_:Binperson' binPhone: $ref: '#/components/schemas/type_:Binphone' binWeb: $ref: '#/components/schemas/type_:Binweb' boardingLinkId: $ref: '#/components/schemas/type_:BoardingLinkId' boardingStatus: $ref: '#/components/schemas/type_:BoardingStatus' boardingSubStatus: $ref: '#/components/schemas/type_:BoardingStatus' bPhone: $ref: '#/components/schemas/type_:Bphone' bStartdate: $ref: '#/components/schemas/type_:Busstartdate' bState: $ref: '#/components/schemas/type_:Bstate' bSummary: $ref: '#/components/schemas/type_:Bsummary' builderData: $ref: '#/components/schemas/type_:BuilderData' bZip: $ref: '#/components/schemas/type_:Bzip' contactData: $ref: '#/components/schemas/type_:ContactsField' createdAt: $ref: '#/components/schemas/type_:CreatedAt' dbaName: $ref: '#/components/schemas/type_:Dbaname' documentsRef: $ref: '#/components/schemas/type_:BoardingApplicationAttachments' ein: $ref: '#/components/schemas/type_:Ein' externalPaypointId: $ref: '#/components/schemas/type_:ExternalPaypointId' generalEvents: type: array items: $ref: '#/components/schemas/type_:GeneralEvents' description: Events associated with the application. highTicketAmount: $ref: '#/components/schemas/type_:Highticketamt' idApplication: $ref: '#/components/schemas/type_:AppId' lastModified: $ref: '#/components/schemas/type_:LastModified' legalName: $ref: '#/components/schemas/type_:Legalname' license: $ref: '#/components/schemas/type_:License' licenseState: $ref: '#/components/schemas/type_:Licensestate' logo: type: string description: A URL pointing to a logo file. mAddress1: $ref: '#/components/schemas/type_:Maddress' mAddress2: $ref: '#/components/schemas/type_:Maddress1' mccid: type: string mCity: $ref: '#/components/schemas/type_:Mstate' mCountry: $ref: '#/components/schemas/type_:Mcountry' messages: type: array items: $ref: '#/components/schemas/type_:ApplicationDetailsRecordMessagesItem' mState: $ref: '#/components/schemas/type_:Mstate' mZip: $ref: '#/components/schemas/type_:Mzip' orgId: $ref: '#/components/schemas/type_:Orgid' orgParentName: $ref: '#/components/schemas/type_:OrgParentName' ownerData: $ref: '#/components/schemas/type_:Ownership' ownType: $ref: '#/components/schemas/type_:OwnType' pageidentifier: $ref: '#/components/schemas/type_:PageIdentifier' recipientEmailNotification: $ref: '#/components/schemas/type_:RecipientEmailNotification' resumable: $ref: '#/components/schemas/type_:Resumable' salesCode: $ref: '#/components/schemas/type_:SalesCode' serviceData: $ref: '#/components/schemas/type_:Services' signer: $ref: '#/components/schemas/type_:SignerData' taxfillname: $ref: '#/components/schemas/type_:Taxfillname' templateId: $ref: '#/components/schemas/type_:TemplateId' websiteAddress: $ref: '#/components/schemas/type_:Website' whencharged: $ref: '#/components/schemas/type_:Whencharged' whendelivered: $ref: '#/components/schemas/type_:Whendelivered' whenProvided: $ref: '#/components/schemas/type_:Whenprovided' whenrefund: $ref: '#/components/schemas/type_:Whenrefunded' additionalData: $ref: '#/components/schemas/type_:AdditionalDataString' ``` ## SDK Code Examples ```python General success response example for boarding app get. from payabli import payabli client = payabli( api_key="YOUR_API_KEY", ) client.boarding.get_application( app_id=352, ) ``` ```typescript General success response example for boarding app get. import { PayabliClient } from "@payabli/sdk-node"; const client = new PayabliClient({ apiKey: "YOUR_API_KEY" }); await client.boarding.getApplication(352); ``` ```go General success response example for boarding app get. import ( context "context" option "github.com/payabli/sdk-go/option" sdkgoclient "github.com/payabli/sdk-go/client" ) client := sdkgoclient.NewClient( option.WithApiKey( "", ), ) response, err := client.Boarding.GetApplication( context.TODO(), 352, ) ``` ```csharp General success response example for boarding app get. using PayabliApi; var client = new PayabliApiClient("API_KEY"); await client.Boarding.GetApplicationAsync(352); ``` ```ruby General success response example for boarding app get. require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Boarding/read/352") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java General success response example for boarding app get. HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Boarding/read/352") .header("requestToken", "") .asString(); ``` ```php General success response example for boarding app get. request('GET', 'https://api-sandbox.payabli.com/api/Boarding/read/352', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```swift General success response example for boarding app get. import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Boarding/read/352")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers 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() ```