PUT
/
organization
/
update
/
{organizationId}
curl --request PUT \
  --url https://gateway.finhub.cloud/customer/organization/update/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenantId: <tenantid>' \
  --data '{
  "countryOfCorporation": "<string>",
  "legalName": "<string>",
  "isTradingNameExist": true,
  "tradingName": "<string>",
  "taxRegistrationNumber": "<string>",
  "taxIdentificationNumber": "<string>",
  "dateOfIncorporation": "<string>",
  "businesstypes": "<string>",
  "sourceOfIncomingFund": "<string>",
  "purposeOfAccount": "<string>",
  "expectedAnnualActivityOfPlatform": "<string>",
  "registrationNumber": "<string>",
  "businessType": "Partner",
  "shareholders": [
    {
      "id": "<string>",
      "personFullname": "<string>",
      "peerFullname": "<string>",
      "escliationFullname": "<string>",
      "status": "<string>",
      "responsibility": "<string>",
      "positions": "<string>",
      "ownershipPercentage": "<string>",
      "person": {
        "firstName": {
          "name": "<string>",
          "order": 123,
          "abbreviation": "<string>",
          "language": "<string>",
          "native": "<string>",
          "suffix": "<string>",
          "prefix": "<string>"
        },
        "lastName": {
          "name": "<string>",
          "order": 123,
          "abbreviation": "<string>",
          "language": "<string>",
          "native": "<string>",
          "suffix": "<string>",
          "prefix": "<string>"
        },
        "fullName": "<string>",
        "groupId": "<string>",
        "gender": "Male",
        "dateOfBirth": "<string>",
        "placeOfBirth": "<string>",
        "nationality": "<string>",
        "pinCode": "<string>",
        "password": "<string>",
        "email": "<string>",
        "telephoneNumbers": [
          {
            "phoneType": "fixed",
            "operator": "<string>",
            "encoding": "numbers",
            "country": "<string>",
            "number": "<string>",
            "purpose": "<string>"
          }
        ],
        "addresses": [
          {
            "addressPurpose": "<string>",
            "address": {
              "country": "<string>",
              "area": "<string>",
              "zipCode": "<string>",
              "city": "<string>",
              "street": "<string>",
              "streetNumber": [
                "<string>"
              ],
              "building": "<string>",
              "apartment": "<string>",
              "entrance": "<string>",
              "floor": "<string>",
              "doorNumber": "<string>",
              "geoPosition": {
                "latitude": 123,
                "longitude": 123,
                "altitude": 123
              },
              "alternative": {
                "word1": "<string>",
                "word2": "<string>",
                "word3": "<string>"
              },
              "relatedToAddress": [
                {
                  "relationType": "near_by",
                  "address": "<string>"
                }
              ],
              "additionalData": [
                {
                  "name": "<string>",
                  "type": "Number",
                  "value": "<string>"
                }
              ]
            }
          }
        ],
        "documents": [
          {
            "purpose": "KYB",
            "name": "<string>",
            "documentType": "ID front side",
            "location": "<string>",
            "verificationResponse": "<string>",
            "status": "underverification",
            "metadata": [
              {
                "name": "<string>",
                "type": "Number",
                "value": "<string>"
              }
            ]
          }
        ],
        "SecretQuestion": [
          {
            "question": "<string>",
            "answer": "<string>"
          }
        ]
      },
      "escallation": {
        "firstName": {
          "name": "<string>",
          "order": 123,
          "abbreviation": "<string>",
          "language": "<string>",
          "native": "<string>",
          "suffix": "<string>",
          "prefix": "<string>"
        },
        "lastName": {
          "name": "<string>",
          "order": 123,
          "abbreviation": "<string>",
          "language": "<string>",
          "native": "<string>",
          "suffix": "<string>",
          "prefix": "<string>"
        },
        "fullName": "<string>",
        "groupId": "<string>",
        "gender": "Male",
        "dateOfBirth": "<string>",
        "placeOfBirth": "<string>",
        "nationality": "<string>",
        "pinCode": "<string>",
        "password": "<string>",
        "email": "<string>",
        "telephoneNumbers": [
          {
            "phoneType": "fixed",
            "operator": "<string>",
            "encoding": "numbers",
            "country": "<string>",
            "number": "<string>",
            "purpose": "<string>"
          }
        ],
        "addresses": [
          {
            "addressPurpose": "<string>",
            "address": {
              "country": "<string>",
              "area": "<string>",
              "zipCode": "<string>",
              "city": "<string>",
              "street": "<string>",
              "streetNumber": [
                "<string>"
              ],
              "building": "<string>",
              "apartment": "<string>",
              "entrance": "<string>",
              "floor": "<string>",
              "doorNumber": "<string>",
              "geoPosition": {
                "latitude": 123,
                "longitude": 123,
                "altitude": 123
              },
              "alternative": {
                "word1": "<string>",
                "word2": "<string>",
                "word3": "<string>"
              },
              "relatedToAddress": [
                {
                  "relationType": "near_by",
                  "address": "<string>"
                }
              ],
              "additionalData": [
                {
                  "name": "<string>",
                  "type": "Number",
                  "value": "<string>"
                }
              ]
            }
          }
        ],
        "documents": [
          {
            "purpose": "KYB",
            "name": "<string>",
            "documentType": "ID front side",
            "location": "<string>",
            "verificationResponse": "<string>",
            "status": "underverification",
            "metadata": [
              {
                "name": "<string>",
                "type": "Number",
                "value": "<string>"
              }
            ]
          }
        ],
        "SecretQuestion": [
          {
            "question": "<string>",
            "answer": "<string>"
          }
        ]
      },
      "peers": {
        "firstName": {
          "name": "<string>",
          "order": 123,
          "abbreviation": "<string>",
          "language": "<string>",
          "native": "<string>",
          "suffix": "<string>",
          "prefix": "<string>"
        },
        "lastName": {
          "name": "<string>",
          "order": 123,
          "abbreviation": "<string>",
          "language": "<string>",
          "native": "<string>",
          "suffix": "<string>",
          "prefix": "<string>"
        },
        "fullName": "<string>",
        "groupId": "<string>",
        "gender": "Male",
        "dateOfBirth": "<string>",
        "placeOfBirth": "<string>",
        "nationality": "<string>",
        "pinCode": "<string>",
        "password": "<string>",
        "email": "<string>",
        "telephoneNumbers": [
          {
            "phoneType": "fixed",
            "operator": "<string>",
            "encoding": "numbers",
            "country": "<string>",
            "number": "<string>",
            "purpose": "<string>"
          }
        ],
        "addresses": [
          {
            "addressPurpose": "<string>",
            "address": {
              "country": "<string>",
              "area": "<string>",
              "zipCode": "<string>",
              "city": "<string>",
              "street": "<string>",
              "streetNumber": [
                "<string>"
              ],
              "building": "<string>",
              "apartment": "<string>",
              "entrance": "<string>",
              "floor": "<string>",
              "doorNumber": "<string>",
              "geoPosition": {
                "latitude": 123,
                "longitude": 123,
                "altitude": 123
              },
              "alternative": {
                "word1": "<string>",
                "word2": "<string>",
                "word3": "<string>"
              },
              "relatedToAddress": [
                {
                  "relationType": "near_by",
                  "address": "<string>"
                }
              ],
              "additionalData": [
                {
                  "name": "<string>",
                  "type": "Number",
                  "value": "<string>"
                }
              ]
            }
          }
        ],
        "documents": [
          {
            "purpose": "KYB",
            "name": "<string>",
            "documentType": "ID front side",
            "location": "<string>",
            "verificationResponse": "<string>",
            "status": "underverification",
            "metadata": [
              {
                "name": "<string>",
                "type": "Number",
                "value": "<string>"
              }
            ]
          }
        ],
        "SecretQuestion": [
          {
            "question": "<string>",
            "answer": "<string>"
          }
        ]
      }
    }
  ],
  "relatedTo": {
    "relationType": "<string>",
    "organizationID": "<string>"
  },
  "website": "<string>",
  "businessSector": "<string>",
  "rangeOfServicesOrGoods": "<string>",
  "transactionPredict": {
    "MonthlyVolumeRange": 123,
    "NumberOfMonthlyPayment": 123,
    "MaxSinglePayment": 123
  },
  "countryList": {
    "SendList": [
      "<string>"
    ],
    "ReceiveList": [
      "<string>"
    ]
  },
  "telephoneNumber": [
    {
      "phoneType": "fixed",
      "operator": "<string>",
      "encoding": "numbers",
      "country": "<string>",
      "number": "<string>",
      "purpose": "<string>"
    }
  ],
  "addresses": [
    {
      "addressPurpose": "<string>",
      "address": {
        "country": "<string>",
        "area": "<string>",
        "zipCode": "<string>",
        "city": "<string>",
        "street": "<string>",
        "streetNumber": [
          "<string>"
        ],
        "building": "<string>",
        "apartment": "<string>",
        "entrance": "<string>",
        "floor": "<string>",
        "doorNumber": "<string>",
        "geoPosition": {
          "latitude": 123,
          "longitude": 123,
          "altitude": 123
        },
        "alternative": {
          "word1": "<string>",
          "word2": "<string>",
          "word3": "<string>"
        },
        "relatedToAddress": [
          {
            "relationType": "near_by",
            "address": "<string>"
          }
        ],
        "additionalData": [
          {
            "name": "<string>",
            "type": "Number",
            "value": "<string>"
          }
        ]
      }
    }
  ],
  "documents": [
    {
      "purpose": "KYB",
      "name": "<string>",
      "documentType": "ID front side",
      "location": "<string>",
      "verificationResponse": "<string>",
      "status": "underverification",
      "metadata": [
        {
          "name": "<string>",
          "type": "Number",
          "value": "<string>"
        }
      ]
    }
  ],
  "businessToBusinessMap": [
    {
      "relationType": "Partner",
      "tenannaId": "<string>",
      "organizationId": "<string>",
      "RelatingorganizationId": "<string>"
    }
  ],
  "businessToCustomerMap": [
    {
      "relationType": "Employee",
      "tenannaId": "<string>",
      "personid": "<string>",
      "organizationId": "<string>"
    }
  ]
}'
{
  "tenantId": "<string>",
  "organization": {
    "countryOfCorporation": "<string>",
    "legalName": "<string>",
    "isTradingNameExist": true,
    "tradingName": "<string>",
    "taxRegistrationNumber": "<string>",
    "taxIdentificationNumber": "<string>",
    "dateOfIncorporation": "<string>",
    "businesstypes": "<string>",
    "sourceOfIncomingFund": "<string>",
    "purposeOfAccount": "<string>",
    "expectedAnnualActivityOfPlatform": "<string>",
    "registrationNumber": "<string>",
    "businessType": "Partner",
    "shareholders": [
      {
        "id": "<string>",
        "personFullname": "<string>",
        "peerFullname": "<string>",
        "escliationFullname": "<string>",
        "status": "<string>",
        "responsibility": "<string>",
        "positions": "<string>",
        "ownershipPercentage": "<string>",
        "person": {
          "firstName": {
            "name": "<string>",
            "order": 123,
            "abbreviation": "<string>",
            "language": "<string>",
            "native": "<string>",
            "suffix": "<string>",
            "prefix": "<string>"
          },
          "lastName": {
            "name": "<string>",
            "order": 123,
            "abbreviation": "<string>",
            "language": "<string>",
            "native": "<string>",
            "suffix": "<string>",
            "prefix": "<string>"
          },
          "fullName": "<string>",
          "groupId": "<string>",
          "gender": "Male",
          "dateOfBirth": "<string>",
          "placeOfBirth": "<string>",
          "nationality": "<string>",
          "pinCode": "<string>",
          "password": "<string>",
          "email": "<string>",
          "telephoneNumbers": [
            {
              "phoneType": "fixed",
              "operator": "<string>",
              "encoding": "numbers",
              "country": "<string>",
              "number": "<string>",
              "purpose": "<string>"
            }
          ],
          "addresses": [
            {
              "addressPurpose": "<string>",
              "address": {
                "country": "<string>",
                "area": "<string>",
                "zipCode": "<string>",
                "city": "<string>",
                "street": "<string>",
                "streetNumber": [
                  "<string>"
                ],
                "building": "<string>",
                "apartment": "<string>",
                "entrance": "<string>",
                "floor": "<string>",
                "doorNumber": "<string>",
                "geoPosition": {
                  "latitude": 123,
                  "longitude": 123,
                  "altitude": 123
                },
                "alternative": {
                  "word1": "<string>",
                  "word2": "<string>",
                  "word3": "<string>"
                },
                "relatedToAddress": [
                  {
                    "relationType": "near_by",
                    "address": "<string>"
                  }
                ],
                "additionalData": [
                  {
                    "name": "<string>",
                    "type": "Number",
                    "value": "<string>"
                  }
                ]
              }
            }
          ],
          "documents": [
            {
              "purpose": "KYB",
              "name": "<string>",
              "documentType": "ID front side",
              "location": "<string>",
              "verificationResponse": "<string>",
              "status": "underverification",
              "metadata": [
                {
                  "name": "<string>",
                  "type": "Number",
                  "value": "<string>"
                }
              ]
            }
          ],
          "SecretQuestion": [
            {
              "question": "<string>",
              "answer": "<string>"
            }
          ]
        },
        "escallation": {
          "firstName": {
            "name": "<string>",
            "order": 123,
            "abbreviation": "<string>",
            "language": "<string>",
            "native": "<string>",
            "suffix": "<string>",
            "prefix": "<string>"
          },
          "lastName": {
            "name": "<string>",
            "order": 123,
            "abbreviation": "<string>",
            "language": "<string>",
            "native": "<string>",
            "suffix": "<string>",
            "prefix": "<string>"
          },
          "fullName": "<string>",
          "groupId": "<string>",
          "gender": "Male",
          "dateOfBirth": "<string>",
          "placeOfBirth": "<string>",
          "nationality": "<string>",
          "pinCode": "<string>",
          "password": "<string>",
          "email": "<string>",
          "telephoneNumbers": [
            {
              "phoneType": "fixed",
              "operator": "<string>",
              "encoding": "numbers",
              "country": "<string>",
              "number": "<string>",
              "purpose": "<string>"
            }
          ],
          "addresses": [
            {
              "addressPurpose": "<string>",
              "address": {
                "country": "<string>",
                "area": "<string>",
                "zipCode": "<string>",
                "city": "<string>",
                "street": "<string>",
                "streetNumber": [
                  "<string>"
                ],
                "building": "<string>",
                "apartment": "<string>",
                "entrance": "<string>",
                "floor": "<string>",
                "doorNumber": "<string>",
                "geoPosition": {
                  "latitude": 123,
                  "longitude": 123,
                  "altitude": 123
                },
                "alternative": {
                  "word1": "<string>",
                  "word2": "<string>",
                  "word3": "<string>"
                },
                "relatedToAddress": [
                  {
                    "relationType": "near_by",
                    "address": "<string>"
                  }
                ],
                "additionalData": [
                  {
                    "name": "<string>",
                    "type": "Number",
                    "value": "<string>"
                  }
                ]
              }
            }
          ],
          "documents": [
            {
              "purpose": "KYB",
              "name": "<string>",
              "documentType": "ID front side",
              "location": "<string>",
              "verificationResponse": "<string>",
              "status": "underverification",
              "metadata": [
                {
                  "name": "<string>",
                  "type": "Number",
                  "value": "<string>"
                }
              ]
            }
          ],
          "SecretQuestion": [
            {
              "question": "<string>",
              "answer": "<string>"
            }
          ]
        },
        "peers": {
          "firstName": {
            "name": "<string>",
            "order": 123,
            "abbreviation": "<string>",
            "language": "<string>",
            "native": "<string>",
            "suffix": "<string>",
            "prefix": "<string>"
          },
          "lastName": {
            "name": "<string>",
            "order": 123,
            "abbreviation": "<string>",
            "language": "<string>",
            "native": "<string>",
            "suffix": "<string>",
            "prefix": "<string>"
          },
          "fullName": "<string>",
          "groupId": "<string>",
          "gender": "Male",
          "dateOfBirth": "<string>",
          "placeOfBirth": "<string>",
          "nationality": "<string>",
          "pinCode": "<string>",
          "password": "<string>",
          "email": "<string>",
          "telephoneNumbers": [
            {
              "phoneType": "fixed",
              "operator": "<string>",
              "encoding": "numbers",
              "country": "<string>",
              "number": "<string>",
              "purpose": "<string>"
            }
          ],
          "addresses": [
            {
              "addressPurpose": "<string>",
              "address": {
                "country": "<string>",
                "area": "<string>",
                "zipCode": "<string>",
                "city": "<string>",
                "street": "<string>",
                "streetNumber": [
                  "<string>"
                ],
                "building": "<string>",
                "apartment": "<string>",
                "entrance": "<string>",
                "floor": "<string>",
                "doorNumber": "<string>",
                "geoPosition": {
                  "latitude": 123,
                  "longitude": 123,
                  "altitude": 123
                },
                "alternative": {
                  "word1": "<string>",
                  "word2": "<string>",
                  "word3": "<string>"
                },
                "relatedToAddress": [
                  {
                    "relationType": "near_by",
                    "address": "<string>"
                  }
                ],
                "additionalData": [
                  {
                    "name": "<string>",
                    "type": "Number",
                    "value": "<string>"
                  }
                ]
              }
            }
          ],
          "documents": [
            {
              "purpose": "KYB",
              "name": "<string>",
              "documentType": "ID front side",
              "location": "<string>",
              "verificationResponse": "<string>",
              "status": "underverification",
              "metadata": [
                {
                  "name": "<string>",
                  "type": "Number",
                  "value": "<string>"
                }
              ]
            }
          ],
          "SecretQuestion": [
            {
              "question": "<string>",
              "answer": "<string>"
            }
          ]
        }
      }
    ],
    "relatedTo": {
      "relationType": "<string>",
      "organizationID": "<string>"
    },
    "website": "<string>",
    "businessSector": "<string>",
    "rangeOfServicesOrGoods": "<string>",
    "transactionPredict": {
      "MonthlyVolumeRange": 123,
      "NumberOfMonthlyPayment": 123,
      "MaxSinglePayment": 123
    },
    "countryList": {
      "SendList": [
        "<string>"
      ],
      "ReceiveList": [
        "<string>"
      ]
    },
    "telephoneNumber": [
      {
        "phoneType": "fixed",
        "operator": "<string>",
        "encoding": "numbers",
        "country": "<string>",
        "number": "<string>",
        "purpose": "<string>"
      }
    ],
    "addresses": [
      {
        "addressPurpose": "<string>",
        "address": {
          "country": "<string>",
          "area": "<string>",
          "zipCode": "<string>",
          "city": "<string>",
          "street": "<string>",
          "streetNumber": [
            "<string>"
          ],
          "building": "<string>",
          "apartment": "<string>",
          "entrance": "<string>",
          "floor": "<string>",
          "doorNumber": "<string>",
          "geoPosition": {
            "latitude": 123,
            "longitude": 123,
            "altitude": 123
          },
          "alternative": {
            "word1": "<string>",
            "word2": "<string>",
            "word3": "<string>"
          },
          "relatedToAddress": [
            {
              "relationType": "near_by",
              "address": "<string>"
            }
          ],
          "additionalData": [
            {
              "name": "<string>",
              "type": "Number",
              "value": "<string>"
            }
          ]
        }
      }
    ],
    "documents": [
      {
        "purpose": "KYB",
        "name": "<string>",
        "documentType": "ID front side",
        "location": "<string>",
        "verificationResponse": "<string>",
        "status": "underverification",
        "metadata": [
          {
            "name": "<string>",
            "type": "Number",
            "value": "<string>"
          }
        ]
      }
    ],
    "businessToBusinessMap": [
      {
        "relationType": "Partner",
        "tenannaId": "<string>",
        "organizationId": "<string>",
        "RelatingorganizationId": "<string>"
      }
    ],
    "businessToCustomerMap": [
      {
        "relationType": "Employee",
        "tenannaId": "<string>",
        "personid": "<string>",
        "organizationId": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

tenantId
string
required

Tenant/Owner id

Path Parameters

organizationId
string
required

Body

application/json
countryOfCorporation
string
legalName
string
isTradingNameExist
boolean
default: false
tradingName
string
taxRegistrationNumber
string
taxIdentificationNumber
string
dateOfIncorporation
string
businesstypes
string
sourceOfIncomingFund
string
purposeOfAccount
string
expectedAnnualActivityOfPlatform
string
registrationNumber
string
businessType
enum<string>
Available options:
Partner,
Supplier
shareholders
object[]
relatedTo
object
website
string
businessSector
string
rangeOfServicesOrGoods
string
transactionPredict
object
countryList
object
telephoneNumber
object[]
addresses
object[]
documents
object[]
businessToBusinessMap
object[]
businessToCustomerMap
object[]

Response

200 - application/json
tenantId
string
organization
object