Skip to main content
PUT
/
sandbox
/
company
JavaScript
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

const company = await client.sandbox.company.update({
  accounts: [{}],
  departments: [{}],
  ein: 'ein',
  entity: {},
  legal_name: 'legal_name',
  locations: [
    {
      city: 'city',
      country: 'country',
      line1: 'line1',
      line2: 'line2',
      postal_code: 'postal_code',
      state: 'state',
    },
  ],
  primary_email: 'dev@stainless.com',
  primary_phone_number: 'primary_phone_number',
});

console.log(company.accounts);
from finch import Finch

client = Finch(
access_token="My Access Token",
)
company = client.sandbox.company.update(
accounts=[{}],
departments=[{}],
ein="ein",
entity={},
legal_name="legal_name",
locations=[{
"city": "city",
"country": "country",
"line1": "line1",
"line2": "line2",
"postal_code": "postal_code",
"state": "state",
}],
primary_email="dev@stainless.com",
primary_phone_number="primary_phone_number",
)
print(company.accounts)
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"),
)
company, err := client.Sandbox.Company.Update(context.TODO(), finchgo.SandboxCompanyUpdateParams{
Accounts: finchgo.F([]finchgo.SandboxCompanyUpdateParamsAccount{{}}),
Departments: finchgo.F([]finchgo.SandboxCompanyUpdateParamsDepartment{{}}),
Ein: finchgo.F("ein"),
Entity: finchgo.F(finchgo.SandboxCompanyUpdateParamsEntity{}),
LegalName: finchgo.F("legal_name"),
Locations: finchgo.F([]finchgo.LocationParam{{
City: finchgo.F("city"),
Country: finchgo.F("country"),
Line1: finchgo.F("line1"),
Line2: finchgo.F("line2"),
PostalCode: finchgo.F("postal_code"),
State: finchgo.F("state"),
}}),
PrimaryEmail: finchgo.F("dev@stainless.com"),
PrimaryPhoneNumber: finchgo.F("primary_phone_number"),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", company.Accounts)
}
package com.tryfinch.api.example;

import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.CompanyUpdateResponse;
import com.tryfinch.api.models.Location;
import com.tryfinch.api.models.SandboxCompanyUpdateParams;

public final class Main {
private Main() {}

public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();

SandboxCompanyUpdateParams params = SandboxCompanyUpdateParams.builder()
.addAccount(SandboxCompanyUpdateParams.Account.builder().build())
.addDepartment(SandboxCompanyUpdateParams.Department.builder().build())
.ein("ein")
.entity(SandboxCompanyUpdateParams.Entity.builder().build())
.legalName("legal_name")
.addLocation(Location.builder()
.city("city")
.country("country")
.line1("line1")
.line2("line2")
.postalCode("postal_code")
.state("state")
.build())
.primaryEmail("dev@stainless.com")
.primaryPhoneNumber("primary_phone_number")
.build();
CompanyUpdateResponse company = client.sandbox().company().update(params);
}
}
package com.tryfinch.api.example

import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.CompanyUpdateResponse
import com.tryfinch.api.models.Location
import com.tryfinch.api.models.SandboxCompanyUpdateParams

fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()

val params: SandboxCompanyUpdateParams = SandboxCompanyUpdateParams.builder()
.addAccount(SandboxCompanyUpdateParams.Account.builder().build())
.addDepartment(SandboxCompanyUpdateParams.Department.builder().build())
.ein("ein")
.entity(SandboxCompanyUpdateParams.Entity.builder().build())
.legalName("legal_name")
.addLocation(Location.builder()
.city("city")
.country("country")
.line1("line1")
.line2("line2")
.postalCode("postal_code")
.state("state")
.build())
.primaryEmail("dev@stainless.com")
.primaryPhoneNumber("primary_phone_number")
.build()
val company: CompanyUpdateResponse = client.sandbox().company().update(params)
}
require "finch_api"

finch = FinchAPI::Client.new(access_token: "My Access Token")

company = finch.sandbox.company.update(
accounts: [{}],
departments: [{}],
ein: "ein",
entity: {},
legal_name: "legal_name",
locations: [
{city: "city", country: "country", line1: "line1", line2: "line2", postal_code: "postal_code", state: "state"}
],
primary_email: "dev@stainless.com",
primary_phone_number: "primary_phone_number"
)

puts(company)
curl --request PUT \
--url https://api.tryfinch.com/sandbox/company \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"legal_name": "Profound Platform Inc",
"ein": "123456789"
}
'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/sandbox/company",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'legal_name' => 'Profound Platform Inc',
'ein' => '123456789'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
  "legal_name": "<string>",
  "entity": {},
  "primary_email": "jsmith@example.com",
  "primary_phone_number": "<string>",
  "departments": [
    {
      "name": "<string>",
      "parent": {
        "name": "<string>"
      }
    }
  ],
  "ein": "<string>",
  "locations": [
    {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "name": "<string>",
      "source_id": "<string>"
    }
  ],
  "accounts": [
    {
      "routing_number": "<string>",
      "account_name": "<string>",
      "institution_name": "<string>",
      "account_number": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Please use your Access Token

Body

application/json

The legal name of the company.

entity
object | null

The entity type object.

primary_email
string<email> | null

The email of the main administrator on the account.

primary_phone_number
string | null

The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. +NNNNNNNNNNN xExtension

departments
(object | null)[] | null

The array of company departments.

ein
string | null

The employer identification number.

locations
(Location · object | null)[] | null
accounts
object[] | null

An array of bank account objects associated with the payroll/HRIS system.

Response

200 - application/json

OK

The legal name of the company.

entity
object | null

The entity type object.

primary_email
string<email> | null

The email of the main administrator on the account.

primary_phone_number
string | null

The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. +NNNNNNNNNNN xExtension

departments
(object | null)[] | null

The array of company departments.

ein
string | null

The employer identification number.

locations
(Location · object | null)[] | null
accounts
object[] | null

An array of bank account objects associated with the payroll/HRIS system.