JavaScript
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
const registerCompanyBenefitResponse = await client.hris.benefits.register();
console.log(registerCompanyBenefitResponse.benefit_id);from finch import Finch
client = Finch(
access_token="My Access Token",
)
register_company_benefit_response = client.hris.benefits.register()
print(register_company_benefit_response.benefit_id)package main
import (
"context"
"fmt"
"github.com/Finch-API/finch-api-go"
"github.com/Finch-API/finch-api-go/option"
)
func main() {
client := finchgo.NewClient(
option.WithAccessToken("My Access Token"),
)
registerCompanyBenefitResponse, err := client.HRIS.Benefits.Register(context.TODO(), finchgo.HRISBenefitRegisterParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", registerCompanyBenefitResponse.BenefitID)
}
package com.tryfinch.api.example;
import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.HrisBenefitRegisterParams;
import com.tryfinch.api.models.RegisterCompanyBenefitResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();
RegisterCompanyBenefitResponse registerCompanyBenefitResponse = client.hris().benefits().register();
}
}package com.tryfinch.api.example
import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.HrisBenefitRegisterParams
import com.tryfinch.api.models.RegisterCompanyBenefitResponse
fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()
val registerCompanyBenefitResponse: RegisterCompanyBenefitResponse = client.hris().benefits().register()
}require "finch_api"
finch = FinchAPI::Client.new(access_token: "My Access Token")
register_company_benefit_response = finch.hris.benefits.register
puts(register_company_benefit_response)curl --request POST \
--url https://api.tryfinch.com/employer/benefits/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: <content-type>' \
--header 'Finch-API-Version: <finch-api-version>' \
--data '
{
"description": "<string>"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/employer/benefits/register",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: <content-type>",
"Finch-API-Version: <finch-api-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"benefit_id": "e8b90071-0c11-471c-86e8-e303ef2f6782",
"job_id": "be1b3351-a88e-46c2-96e4-c2cf38e529a7"
}{
"code": 400,
"name": "invalid_request_error",
"message": "This adapter does not support assisted benefits."
}{
"code": 422,
"name": "unprocessable_request_error",
"finch_code": "unsupported_paramters",
"message": "Provider does not support benefit type '401k'"
}Deductions
Register Deduction
Register existing benefits from the customer on the provider, on Finch’s end. Please use the /provider endpoint to view available types for each provider.
POST
/
employer
/
benefits
/
register
JavaScript
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
const registerCompanyBenefitResponse = await client.hris.benefits.register();
console.log(registerCompanyBenefitResponse.benefit_id);from finch import Finch
client = Finch(
access_token="My Access Token",
)
register_company_benefit_response = client.hris.benefits.register()
print(register_company_benefit_response.benefit_id)package main
import (
"context"
"fmt"
"github.com/Finch-API/finch-api-go"
"github.com/Finch-API/finch-api-go/option"
)
func main() {
client := finchgo.NewClient(
option.WithAccessToken("My Access Token"),
)
registerCompanyBenefitResponse, err := client.HRIS.Benefits.Register(context.TODO(), finchgo.HRISBenefitRegisterParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", registerCompanyBenefitResponse.BenefitID)
}
package com.tryfinch.api.example;
import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.HrisBenefitRegisterParams;
import com.tryfinch.api.models.RegisterCompanyBenefitResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();
RegisterCompanyBenefitResponse registerCompanyBenefitResponse = client.hris().benefits().register();
}
}package com.tryfinch.api.example
import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.HrisBenefitRegisterParams
import com.tryfinch.api.models.RegisterCompanyBenefitResponse
fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()
val registerCompanyBenefitResponse: RegisterCompanyBenefitResponse = client.hris().benefits().register()
}require "finch_api"
finch = FinchAPI::Client.new(access_token: "My Access Token")
register_company_benefit_response = finch.hris.benefits.register
puts(register_company_benefit_response)curl --request POST \
--url https://api.tryfinch.com/employer/benefits/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: <content-type>' \
--header 'Finch-API-Version: <finch-api-version>' \
--data '
{
"description": "<string>"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/employer/benefits/register",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: <content-type>",
"Finch-API-Version: <finch-api-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"benefit_id": "e8b90071-0c11-471c-86e8-e303ef2f6782",
"job_id": "be1b3351-a88e-46c2-96e4-c2cf38e529a7"
}{
"code": 400,
"name": "invalid_request_error",
"message": "This adapter does not support assisted benefits."
}{
"code": 422,
"name": "unprocessable_request_error",
"finch_code": "unsupported_paramters",
"message": "Provider does not support benefit type '401k'"
}Availability: Assisted providers only
Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Pattern:
([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))Used to indicate the original media type of the resource
Query Parameters
The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.
Required array length:
1 elementExample:
["550e8400-e29b-41d4-a716-446655440000"]
Body
application/json
Type of benefit.
Available options:
457, 401k, 401k_roth, 401k_loan, 403b, 403b_roth, 457_roth, commuter, custom_post_tax, custom_pre_tax, fsa_dependent_care, fsa_medical, hsa_post, hsa_pre, s125_dental, s125_medical, s125_vision, simple, simple_ira, null The frequency of the benefit deduction/contribution.
Available options:
every_paycheck, monthly, one_time, null Was this page helpful?