JavaScript
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
const individual = await client.sandbox.individual.update('individual_id');
console.log(individual.id);from finch import Finch
client = Finch(
access_token="My Access Token",
)
individual = client.sandbox.individual.update(
individual_id="individual_id",
)
print(individual.id)package main
import (
"context"
"fmt"
"github.com/Finch-API/finch-api-go/v2"
"github.com/Finch-API/finch-api-go/v2/option"
)
func main() {
client := finchgo.NewClient(
option.WithAccessToken("My Access Token"),
)
individual, err := client.Sandbox.Individual.Update(
context.TODO(),
"individual_id",
finchgo.SandboxIndividualUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", individual.ID)
}
package com.tryfinch.api.example;
import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.IndividualUpdateResponse;
import com.tryfinch.api.models.SandboxIndividualUpdateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();
IndividualUpdateResponse individual = client.sandbox().individual().update("individual_id");
}
}package com.tryfinch.api.example
import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.IndividualUpdateResponse
import com.tryfinch.api.models.SandboxIndividualUpdateParams
fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()
val individual: IndividualUpdateResponse = client.sandbox().individual().update("individual_id")
}require "finch_api"
finch = FinchAPI::Client.new(access_token: "My Access Token")
individual = finch.sandbox.individual.update("individual_id")
puts(individual)curl --request PUT \
--url https://api.tryfinch.com/sandbox/individual/{individual_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"preferred_name": "<string>",
"emails": [
{
"data": "<string>"
}
],
"phone_numbers": [
{
"data": "<string>"
}
],
"dob": "<string>",
"ssn": "<string>",
"encrypted_ssn": "<string>",
"residence": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"name": "<string>",
"source_id": "<string>"
}
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/sandbox/individual/{individual_id}",
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([
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'preferred_name' => '<string>',
'emails' => [
[
'data' => '<string>'
]
],
'phone_numbers' => [
[
'data' => '<string>'
]
],
'dob' => '<string>',
'ssn' => '<string>',
'encrypted_ssn' => '<string>',
'residence' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'name' => '<string>',
'source_id' => '<string>'
]
]),
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;
}{
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"preferred_name": "<string>",
"emails": [
{
"data": "<string>",
"type": "work"
}
],
"phone_numbers": [
{
"data": "<string>",
"type": "work"
}
],
"gender": "female",
"ethnicity": "asian",
"marital_status": "single",
"dob": "<string>",
"ssn": "<string>",
"encrypted_ssn": "<string>",
"residence": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"name": "<string>",
"source_id": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Sandbox
Update sandbox individual
PUT
/
sandbox
/
individual
/
{individual_id}
JavaScript
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
const individual = await client.sandbox.individual.update('individual_id');
console.log(individual.id);from finch import Finch
client = Finch(
access_token="My Access Token",
)
individual = client.sandbox.individual.update(
individual_id="individual_id",
)
print(individual.id)package main
import (
"context"
"fmt"
"github.com/Finch-API/finch-api-go/v2"
"github.com/Finch-API/finch-api-go/v2/option"
)
func main() {
client := finchgo.NewClient(
option.WithAccessToken("My Access Token"),
)
individual, err := client.Sandbox.Individual.Update(
context.TODO(),
"individual_id",
finchgo.SandboxIndividualUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", individual.ID)
}
package com.tryfinch.api.example;
import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.IndividualUpdateResponse;
import com.tryfinch.api.models.SandboxIndividualUpdateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();
IndividualUpdateResponse individual = client.sandbox().individual().update("individual_id");
}
}package com.tryfinch.api.example
import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.IndividualUpdateResponse
import com.tryfinch.api.models.SandboxIndividualUpdateParams
fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()
val individual: IndividualUpdateResponse = client.sandbox().individual().update("individual_id")
}require "finch_api"
finch = FinchAPI::Client.new(access_token: "My Access Token")
individual = finch.sandbox.individual.update("individual_id")
puts(individual)curl --request PUT \
--url https://api.tryfinch.com/sandbox/individual/{individual_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"preferred_name": "<string>",
"emails": [
{
"data": "<string>"
}
],
"phone_numbers": [
{
"data": "<string>"
}
],
"dob": "<string>",
"ssn": "<string>",
"encrypted_ssn": "<string>",
"residence": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"name": "<string>",
"source_id": "<string>"
}
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/sandbox/individual/{individual_id}",
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([
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'preferred_name' => '<string>',
'emails' => [
[
'data' => '<string>'
]
],
'phone_numbers' => [
[
'data' => '<string>'
]
],
'dob' => '<string>',
'ssn' => '<string>',
'encrypted_ssn' => '<string>',
'residence' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'name' => '<string>',
'source_id' => '<string>'
]
]),
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;
}{
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"preferred_name": "<string>",
"emails": [
{
"data": "<string>",
"type": "work"
}
],
"phone_numbers": [
{
"data": "<string>",
"type": "work"
}
],
"gender": "female",
"ethnicity": "asian",
"marital_status": "single",
"dob": "<string>",
"ssn": "<string>",
"encrypted_ssn": "<string>",
"residence": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"name": "<string>",
"source_id": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Body
application/json
Social Security Number of the individual. This field is only available with the ssn scope enabled and the options: { include: ['ssn'] } param set in the body. Click here to learn more about enabling the SSN field.
Response
200 - application/json
OK
Social Security Number of the individual. This field is only available with the ssn scope enabled and the options: { include: ['ssn'] } param set in the body. Click here to learn more about enabling the SSN field.
Was this page helpful?