Skip to main content
GET
Returns the client configuration

Authorizations

X-API-KEY
string
header
required

Response

OK

payslip_upload_enabled
boolean

Determines if payslip upload via documents is allowed as a fallback if there is not connection to payroll providers

Example:

true

payroll_period_months
integer<int32>

Lookback period of the payroll to search on account creation

Example:

24

Client logo asset or URL

Example:

"image.png"

client_callback_url
string

Callback URL for client application. This will be redirected to once the user completes their journey on Teal's platform

Example:

"https://app.client.com/callback"

recurring_checks_enabled
boolean

Determines if recurring checks are enabled client-wide

Example:

true

recurring_check_frequency
string

Frequency of the recurring check for the client. Available frequencies in production are [WEEKLY, MONTHLY]. Sandbox allows HOURLY frequency in addition.

Example:

"WEEKLY"

recurring_check_end_date
string<date-time>

End date of the recurring check schedule client-wide

Example:

"2019-05-17T00:00:00.000Z"

payroll_connections_enabled
boolean

Determines if payroll connections feature is enabled for this client. When disabled, the payroll connections endpoint will return an error.

Example:

true

client_display_name
string | null

Editable display name for the client. This can be customized and is separate from the internal client name.

Example:

"Acme Corporation"