POST
/
Boarding
/
read
/
{xId}
curl --request POST \
  --url https://api-sandbox.payabli.com/api/Boarding/read/{xId} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "email": "admin@email.com",
  "referenceId": "n6UCd1f1ygG7"
}'
{
  "idApplication": 352,
  "orgId": 123,
  "orgParentName": "PropertyManager Pro",
  "dbaName": "Sunshine Gutters",
  "legalName": "Sunshine Services, LLC",
  "ein": "123456789",
  "taxfillname": "Sunshine LLC",
  "whencharged": "When Service Provided",
  "whenProvided": "30 Days or Less",
  "whendelivered": "Over 30 Days",
  "whenrefund": "30 Days or Less",
  "licenseState": "CA",
  "license": "2222222FFG",
  "bAddress1": "123 Walnut Street",
  "bAddress2": "Suite 103",
  "bCity": "New Vegas",
  "bZip": "33000",
  "bState": "FL",
  "bCountry": "US",
  "websiteAddress": "www.example.com",
  "bPhone": "5551234567",
  "bSummary": "Brick and mortar store that sells office supplies",
  "bFax": "5551234567",
  "mAddress1": "123 Walnut Street",
  "mAddress2": "STE 900",
  "mCity": "TN",
  "mZip": "37615",
  "mState": "TN",
  "mCountry": "US",
  "bStartdate": "01/01/1990",
  "ownType": "Limited Liability Company",
  "salesCode": "<string>",
  "averageMonthlyVolume": 1000,
  "highTicketAmount": 1000,
  "averageTicketAmount": 1000,
  "annualRevenue": 1000,
  "mccid": "<string>",
  "binPerson": 60,
  "binPhone": 20,
  "binWeb": 20,
  "boardingStatus": 123,
  "boardingSubStatus": 123,
  "templateId": 22,
  "boardingLinkId": 91,
  "logo": {
    "ftype": "pdf",
    "filename": "my-doc.pdf",
    "furl": "https://mysite.com/my-doc.pdf",
    "fContent": "TXkgdGVzdCBmaWxlHJ==..."
  },
  "documentsRef": {
    "zipfile": "zx45.zip",
    "filelist": [
      {
        "originalName": "<string>",
        "zipName": "<string>"
      }
    ]
  },
  "contactData": [
    {
      "contactName": "Herman Martinez",
      "contactEmail": "example@email.com",
      "contactTitle": "Owner",
      "contactPhone": "3055550000"
    }
  ],
  "ownerData": [
    {
      "ownername": "John Smith",
      "ownertitle": "CEO",
      "ownerpercent": 25,
      "ownerssn": "123456789",
      "ownerdob": "01/01/1990",
      "ownerphone1": "555888111",
      "ownerphone2": "555888111",
      "owneremail": "example@email.com",
      "ownerdriver": "CA6677778",
      "odriverstate": "CA",
      "oaddress": "33 North St",
      "ostate": "CA",
      "ocountry": "US",
      "ocity": "Any City",
      "ozip": "55555"
    }
  ],
  "serviceData": {
    "card": {
      "acceptVisa": true,
      "acceptMastercard": true,
      "acceptDiscover": false,
      "acceptAmex": true
    },
    "ach": {
      "acceptWeb": true,
      "acceptPPD": false,
      "acceptCCD": false
    },
    "odp": {
      "allowAch": true,
      "allowChecks": true,
      "allowVCard": true,
      "processor": "tysys",
      "processing_region": "US",
      "programId": 123456
    }
  },
  "bankData": [
    {
      "id": 123,
      "nickname": "Business Checking 1234",
      "bankName": "Country Bank",
      "routingAccount": "123123123",
      "accountNumber": "1XXXXXX3123",
      "typeAccount": "Checking",
      "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
      "bankAccountHolderType": "Business",
      "bankAccountFunction": 0
    }
  ],
  "createdAt": "2022-07-01 15:00:01",
  "lastModified": "2022-07-01 15:00:01",
  "builderData": {
    "business": {
      "details": {
        "dbaname": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "legalname": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "btype": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "website": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ein": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "taxfillname": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "license": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "licstate": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "startdate": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "phonenumber": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "faxnumber": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        }
      },
      "address": {
        "baddress": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "baddress1": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "bcity": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "bstate": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "bzip": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "bcountry": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "maddress": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "maddress1": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "mcity": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "mstate": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "mzip": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "mcountry": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        }
      }
    },
    "owners": {
      "own_list": {
        "ownername": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ownertitle": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ownerpercent": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ownerssn": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ownerdob": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ownerphone1": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ownerphone2": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "owneremail": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ownerdriver": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "odriverstate": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "oaddress": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ostate": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ocountry": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ocity": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "ozip": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        }
      },
      "contact_list": {
        "contactName": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "contactTitle": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "contactEmail": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "contactPhone": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        }
      }
    },
    "processing": {
      "mcc": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "bsummary": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "whenCharged": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "whenProvided": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "whenDelivered": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "whenRefunded": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "binperson": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "binphone": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "binweb": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "avgmonthly": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "ticketamt": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      },
      "highticketamt": {
        "value": "<string>",
        "validator": "<string>",
        "ro": false,
        "rq": true
      }
    },
    "services": {
      "card": {
        "acceptance": {
          "visa": {
            "value": "<string>",
            "validator": "<string>",
            "ro": false,
            "rq": true
          },
          "mastercard": {
            "value": "<string>",
            "validator": "<string>",
            "ro": false,
            "rq": true
          },
          "discover": {
            "value": "<string>",
            "validator": "<string>",
            "ro": false,
            "rq": true
          },
          "amex": {
            "value": "<string>",
            "validator": "<string>",
            "ro": false,
            "rq": true
          }
        },
        "price": {
          "header": {
            "columns": [
              {
                "value": "<string>",
                "validator": "<string>",
                "ro": false,
                "rq": true
              }
            ]
          },
          "body": [
            {
              "columns": [
                {
                  "value": "<string>",
                  "validator": "<string>",
                  "ro": false,
                  "rq": true
                }
              ]
            }
          ]
        },
        "fees": {
          "header": {
            "columns": [
              {
                "value": "<string>",
                "validator": "<string>",
                "ro": false,
                "rq": true
              }
            ]
          },
          "body": [
            {
              "columns": [
                {
                  "value": "<string>",
                  "validator": "<string>",
                  "ro": false,
                  "rq": true
                }
              ]
            }
          ]
        }
      },
      "ach": {
        "acceptance": {
          "web": {
            "value": "<string>",
            "validator": "<string>",
            "ro": false,
            "rq": true
          },
          "ppd": {
            "value": "<string>",
            "validator": "<string>",
            "ro": false,
            "rq": true
          },
          "ccd": {
            "value": "<string>",
            "validator": "<string>",
            "ro": false,
            "rq": true
          }
        },
        "price": {
          "header": {
            "columns": [
              {
                "value": "<string>",
                "validator": "<string>",
                "ro": false,
                "rq": true
              }
            ]
          },
          "body": [
            {
              "columns": [
                {
                  "value": "<string>",
                  "validator": "<string>",
                  "ro": false,
                  "rq": true
                }
              ]
            }
          ]
        },
        "fees": {
          "header": {
            "columns": [
              {
                "value": "<string>",
                "validator": "<string>",
                "ro": false,
                "rq": true
              }
            ]
          },
          "body": [
            {
              "columns": [
                {
                  "value": "<string>",
                  "validator": "<string>",
                  "ro": false,
                  "rq": true
                }
              ]
            }
          ]
        }
      }
    },
    "banking": {
      "depositAccount": {
        "bankName": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "routingAccount": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "accountNumber": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "typeAccount": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        }
      },
      "withdrawalAccount": {
        "bankName": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "routingAccount": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "accountNumber": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        },
        "typeAccount": {
          "value": "<string>",
          "validator": "<string>",
          "ro": false,
          "rq": true
        }
      }
    },
    "attributes": {
      "multipleOwners": true,
      "multipleContacts": true,
      "minimumDocuments": 123
    }
  },
  "signer": {
    "signerUuid": "54455d5d-34ff-416c-91e0-5bc87199999",
    "name": "John Smith",
    "ssn": "123456789",
    "dob": "01/01/1990",
    "phone": "555888111",
    "email": "example@email.com",
    "address": "33 North St",
    "address1": "STE 900",
    "state": "TN",
    "country": "US",
    "city": "Bristol",
    "zip": "55555",
    "acceptance": false,
    "signedDocumentReference": null
  },
  "generalEvents": [
    {
      "description": "TransferCreated",
      "eventTime": "2023-07-05T22:31:06.8317486+00:00",
      "refData": "<string>",
      "extraData": {},
      "source": "api"
    }
  ],
  "pageidentifier": "null",
  "recipientEmailNotification": true,
  "resumable": false,
  "externalPaypointId": "Paypoint-100"
}

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
xId
string
required

The application ID in Hex format. Find this at the end of the boarding link URL returned in a call to api/Boarding/applink/{appId}/{mail2}. For example in: https://boarding-sandbox.payabli.com/boarding/externalapp/load/17E, the xId is 17E.

Example:

"17E"

Body

Authentication for Application. Must include the referenceId returned with a call to api/Boarding/applink/{appId}/{mail2}, and the email address must match the email sent with that call.

The body is of type object.

Response

200 - application/json

Success

The response is of type object.