People

Update a person

put/v1/forms/{form_id}/people/{person_id}

Request

Base URL
https://devapi.currencycloud.com/onboarding
Auth
API key in header X-Auth-Token
TypeScript
https://skmtc.dev/currencycloud/apis/api-onboarding/docs/v1/forms/:form_id/people/:person_id/put.ts
A function with typed inputs. Its response is checked against the schema.

form_idstring required

person_idstring required

rolesstring[] required

document_idsstring[] nullable

first_namestring required

middle_namestring nullable

last_namestring required

dobstring date nullable

phone_numberstring nullable

emailstring nullable

ownership_percentagenumber nullable

id_numberstring nullable

home_countrystring required

passport_numberstring nullable

passport_country_of_issuestring nullable

Updates a person when correct params are provided

Sep 1, 2022e3fe8184a3dd Revision changes
- breaking
  removed the enum value account_creator of the request property /
Aug 31, 2022c563da3e870a Revision changes
- breaking
  removed the required property / from the response with the status
- warning
  removed the request property
- info
  the endpoint scheme security AuthToken was added to the API
- info
  the endpoint scheme security JWT was removed from the API
- info
  added the optional property / to the response with the status