Update US Bank Client

Base URL

Production environment

https://gigadat-api.speedydd.com

Develop environment

https://api-gcp-gigadat-dev.speedydd.com

Endpoint

PUT /organisation/client-data

Description

This endpoint updates an existing US Bank client with comprehensive program manager, program participant, beneficial ownership, and control person details.

Request Headers

Header	Type	Required	Description
x-api-key	string	Yes	Application API Key
Content-Type	string	Yes	Must be application/json

Request Body

Root Object

Field	Type	Required	Description
subClientID	string	Yes	Unique identifier for the sub-client to update
subClientData	object	Yes	US Bank client data object

subClientData Object

Field	Type	Required	Description
programManagerDetails	object	Yes	Program manager information
programParticipantDetails	object	Yes	Program participant information

---

Program Manager Details

Field	Type	Required	Validation	Description
identificationNumber	string	Yes	Exactly 9 characters	EIN/SSN/ITIN
programManagerName	string	Yes	-	Name of the program manager
contactName	string	Yes	-	Contact person name
contactEmailAddress	string	Yes	Valid email format	Contact email address

---

Program Participant Details

Field	Type	Required	Description
entityDetails	object	Yes	Entity information
attestorDetails	object	No	Attestor information
additionalDetails	object	Yes	Additional business details
beneficialOwnershipDetails	array	No	Array of beneficial owner objects
controlPersonDetails	object	Yes	Control person information

Entity Details

Field	Type	Required	Validation	Description
legalName	string	Yes	-	Legal name of the entity
identificationNumber	string	Yes	Exactly 9 characters	Tax identification number
identificationType	string	Yes	Must be "TIN"	Type of identification
programParticipantAttestation	boolean	Yes	-	Program participant attestation flag

Attestor Details

Details such as name of the Attestor.

Field	Type	Required	Validation	Description
firstName	string	Yes	-	First name of attestor
lastName	string	Yes	-	Last name of attestor
jobTitle	string	Yes	-	Designation of attestor
dateOfAttestation	string	Yes	YYYY-MM-DD format	Date of attestation (e.g., "1998-08-23")

Additional Details

Field	Type	Required	Validation	Description
dbaDetails	object	Yes	-	Doing Business As details
tradingDetails	object	No	-	Public trading information
cipExempt	boolean	Yes	-	Customer Identification Program exemption
hasAnyBeneficialOwner	boolean	Yes	-	Indicates if beneficial owners exist
beneficialOwnerExempt	boolean	Yes	-	Beneficial owner exemption status
standardIndustryClassificationCode	string	Yes	-	SIC code
natureOfBusiness	string	Yes	-	Business nature description
legalStructure	string	Yes	-	Legal structure type
countryOfFormation	string	Yes	ISO 3166-1 alpha-2 (2 characters)	Country where entity was formed (e.g., "US")
countryOfPrimaryBusinessOperations	string	Yes	ISO 3166-1 alpha-2 (2 characters)	Primary business operations country (e.g., "US")
projectedAnnualRevenue	number	Yes	-	Projected annual revenue
msbServices	boolean	Yes	-	Money Service Business services flag
businessPhoneNumber	string	Yes	1-10 digits	Business phone number
address	object	Yes	-	Business address

DBA Details

Field	Type	Required	Description
hasAnyDBA	boolean	Yes	Indicates if entity has a DBA
dbaName	string	No	Doing Business As name

Trading Details

Field	Type	Required	Description
publiclyTradedStockSymbol	string	No	Stock symbol
tradedExchange	string	No	Exchange name (e.g., NYSE, NASDAQ)

Address Object

Field	Type	Required	Validation	Description
addressLine1	string	Yes	Max 35 characters	Address line 1
addressLine2	string	Yes	Max 35 characters	Address line 2
city	string	Yes	Max 30 characters	City
state	string	Yes	Exactly 2 characters	State code
zipCode	string	Yes	Max 10 characters	ZIP/Postal code
country	string	Yes	Exactly 2 characters	Country code (ISO 3166-1 alpha-2)
addressType	string	Yes	"business" or "residential"	Address type

---

Beneficial Ownership Details

Array of beneficial owner objects. Each object contains:

Field	Type	Required	Validation	Description
beneficialOwnerFirstName	string	Yes	Max 30 characters	First name
beneficialOwnerLastName	string	Yes	Max 30 characters	Last name
ownershipPercentage	number	Yes	-	Ownership percentage
beneficialOwnerDbaName	string	No	-	DBA name
beneficialOwnerAddress	object	No	-	Address object (optional fields)
beneficialOwnerIdentificationNumber	string	Yes	-	Identification number
identificationType	string	No	"SSN", "ITIN", or "PPN"	Type of identification
identificationIssuingCountry	string	No	ISO 3166-1 alpha-2 (2 characters)	Country that issued the ID (e.g., "US")
beneficialOwnerDateOfBirth	string	No	YYYY-MM-DD format	Date of birth (e.g., "1998-08-23")
beneficialOwnerPhoneNumber	string	No	1-10 digits	Phone number

Beneficial Owner Address (Optional)

Field	Type	Required	Validation	Description
addressLine1	string	No	Max 35 characters	Address line 1
addressLine2	string	No	Max 35 characters	Address line 2
city	string	No	Max 30 characters	City
state	string	No	Exactly 2 characters	State code
zipCode	string	No	Max 10 characters	ZIP/Postal code
country	string	No	ISO 3166-1 alpha-2 (2 characters)	Country code (e.g., "US")
addressType	string	No	"business" or "residential"	Address type

---

Control Person Details

Please provide information on a singular control person such as an executive officer or senior manager with significant responsibility for managing this business entity. If the entity is CIP exempt, you can only provide firstName, lastName, title and address of the Control Person. If the entity is not CIP exempt, please provide all of the Control Person's details.

Field	Type	Required	Validation	Description
titleOfControlPerson	string	Yes	-	Title of the control person (e.g., "CEO", "CFO")
firstName	string	Yes	-	First name
lastName	string	Yes	-	Last name
controlPersonAddress	object	Yes	-	Address object
controlPersonPhoneNumber	string	No	1-10 digits	Phone number (required if not CIP exempt)
controlPersonDateOfBirth	string	No	YYYY-MM-DD format	Date of birth (required if not CIP exempt, e.g., "1998-08-23")
identificationNumber	string	No	-	Identification number (required if not CIP exempt)
identificationType	string	No	"SSN", "ITIN", or "PPN"	Type of identification (required if not CIP exempt)
identificationIssuingCountry	string	No	ISO 3166-1 alpha-2 (2 characters)	Country that issued the ID (required if not CIP exempt, e.g., "US")

---

Request Example

{
  "subClientID": "68f0f79c6c397815fd1c9e08",
  "subClientData": {
    "programManagerDetails": {
      "identificationNumber": "867522981",
      "programManagerName": "ACD Fintech",
      "contactName": "Harry Smith",
      "contactEmailAddress": "abc@hero.com"
    },
    "programParticipantDetails": {
      "entityDetails": {
        "legalName": "ABC Corporation",
        "identificationNumber": "867423981",
        "identificationType": "TIN",
        "programParticipantAttestation": true
      },
      "additionalDetails": {
        "dbaDetails": {
          "hasAnyDBA": true,
          "dbaName": "ABC"
        },
        "tradingDetails": {
          "publiclyTradedStockSymbol": "ABCD",
          "tradedExchange": "NYSE"
        },
        "cipExempt": true,
        "hasAnyBeneficialOwner": true,
        "beneficialOwnerExempt": true,
        "standardIndustryClassificationCode": "237312",
        "natureOfBusiness": "Payment platform",
        "legalStructure": "LLC",
        "countryOfFormation": "US",
        "countryOfPrimaryBusinessOperations": "US",
        "projectedAnnualRevenue": "1000000",
        "msbServices": true,
        "businessPhoneNumber": 5679871234,
        "address": {
          "addressType": "residential",
          "addressLine1": "123 main street",
          "addressLine2": "Suite 301",
          "city": "Hillsboro",
          "state": "OR",
          "zipCode": "97124",
          "country": "US"
        }
      },
      "attestorDetails": {
        "firstName": "John",
        "lastName": "Smith",
        "jobTitle": "Project Manager",
        "dateOfAttestation": "1998-08-23"
      },
      "beneficialOwnershipDetails": [
        {
          "beneficialOwnerFirstName": "John",
          "beneficialOwnerLastName": "Smith",
          "ownershipPercentage": 27.5,
          "identificationIssuingCountry": "US",
          "beneficialOwnerAddress": {
            "addressLine1": "122 main street",
            "addressLine2": "13",
            "city": "Hillsboro",
            "state": "OR",
            "zipCode": "97124",
            "country": "US",
            "addressType": "residential"
          },
          "beneficialOwnerIdentificationNumber": "123266129",
          "identificationType": "SSN",
          "beneficialOwnerDateOfBirth": "1998-08-23",
          "beneficialOwnerPhoneNumber": 5679871231
        }
      ],
      "controlPersonDetails": {
        "titleOfControlPerson": "CFO",
        "firstName": "Roy",
        "lastName": "Sterling",
        "controlPersonAddress": {
          "addressLine1": "3400 John place",
          "addressLine2": "123 n central",
          "city": "Hillsboro",
          "state": "OR",
          "zipCode": "97124",
          "country": "US",
          "addressType": "residential"
        },
        "controlPersonPhoneNumber": 5671121231,
        "controlPersonDateOfBirth": "1998-08-23",
        "identificationNumber": "861273981",
        "identificationType": "SSN",
        "identificationIssuingCountry": "US"
      }
    }
  }
}

Response

Success Response (200 OK)

Empty body

Error Responses

400 Bad Request - Validation Error

{
  "code": 400,
  "message": "[\"[General] One or more identification numbers already exist in another organization.\"]"
}

Other validation error examples:

• "[\"identificationNumber must be exactly 9 characters\"]"
• "[\"state must be exactly 2 characters\"]"
• "[\"contactEmailAddress must be a valid email\"]"
• "[\"businessPhoneNumber must match /^\\d{1,10}$/\"]"

401 Unauthorized

{
  "success": false,
  "message": "Invalid or missing authentication token"
}

404 Not Found

{
  "success": false,
  "message": "Client with this ID not found"
}

500 Internal Server Error

{
  "success": false,
  "message": "An error occurred while updating the client"
}

Validation Rules Summary

• Identification Numbers: Must be exactly 9 characters
• State Codes: Must be exactly 2 characters
• Country Codes: Must be ISO 3166-1 alpha-2 format (2 characters, e.g., "US", "CA")
• Phone Numbers: Must be 1-10 digits only
• Email Addresses: Must be in valid email format
• Address Lines: Maximum 35 characters
• City: Maximum 30 characters
• ZIP Code: Maximum 10 characters
• Names: Maximum 30 characters (for beneficial owners and control persons)
• Address Type: Must be either "business" or "residential"
• Identification Type: Must be "TIN" for entities, "SSN", "ITIN", or "PPN" for individuals
• Dates: Must be in YYYY-MM-DD format (e.g., "1998-08-23")

Notes

1. All required fields must be provided in the request body
2. Optional fields can be omitted from the request
3. The subClientID must match an existing client
4. This endpoint performs a full update - all fields in subClientData should be provided
5. If hasAnyBeneficialOwner is true, provide the beneficialOwnershipDetails array
6. If hasAnyDBA is true, provide the dbaName field
7. Phone numbers should contain only digits (no formatting characters)
8. Country codes should follow ISO 3166-1 alpha-2 standard (2-letter codes like "US", "CA", "GB")
9. Dates should be provided in YYYY-MM-DD format (e.g., "1998-08-23")
10. All monetary values should be provided as numbers without currency symbols