GET
/
Boarding
/
linkbyTemplate
/
{templateId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Boarding/linkbyTemplate/{templateId} \
  --header 'requestToken: <api-key>'
{
  "id": 123,
  "referenceTemplateId": 1830,
  "referenceName": "payabli-00710",
  "acceptRegister": false,
  "acceptOauth": false,
  "entryAttributes": "<string>",
  "orgId": 123,
  "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
    }
  },
  "pageIdentifier:": "null",
  "logo": {
    "ftype": "pdf",
    "filename": "my-doc.pdf",
    "furl": "https://mysite.com/my-doc.pdf",
    "fContent": "TXkgdGVzdCBmaWxlHJ==..."
  },
  "recipientEmailNotification": true,
  "resumable": false
}

Authorizations

​
requestToken
string
header
required

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

Path Parameters

​
templateId
number
required

The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80. Here, the template ID is 80.

Example:

80

Response

200 - application/json
Success
​
id
integer
​
referenceTemplateId
integer | null
Example:

1830

​
referenceName
string | null
Example:

"payabli-00710"

​
acceptRegister
boolean | null
Example:

false

​
acceptOauth
boolean | null
Example:

false

​
entryAttributes
string | null
​
orgId
integer | null

Organization ID. Unique identifier assigned to an org by Payabli.

Example:

123

​
builderData
object
​
pageIdentifier:
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

Object containing logo file.

​
recipientEmailNotification
boolean
default:true

When true, Payabli will send the applicant a boarding link. Set this value to false if you are sending pre-filled applications via the API and don't want Payabli to send the applicant an email to complete the boarding application.

Example:

true

​
resumable
boolean
default:true

When true, the applicant can save an incomplete application and resume it later. When false, the applicant won't have an option to save their progress, and must complete the application in one session.

Example:

false

Was this page helpful?