Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    Documents RenewalDocument [] Body Renewal documents to be uploaded
    RenewalData RenewalData Body Renewal data to be updated
    RenewalEntityId String Route Renewal entity identifier
  • Response Parameters

    View Response Codes

    There are no response parameters

  • Request Example

    Request URL
    PATCH /cm/v1/clientrenewals/7526324
    Request Body
    {
      "Documents": [
        {
          "Data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4",
          "MimeType": "application/pdf",
          "Name": "ProofOfIdentity.pdf",
          "Type": "ProofOfIdentity"
        },
        {
          "Data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4",
          "MimeType": "application/msword",
          "Name": "ProofOfResidency.doc",
          "Type": "ProofOfResidency"
        }
      ],
      "RenewalData": {
        "AustraliaData": {
          "AnnualIncome": "3",
          "NetWorth": "5"
        },
        "FinlandData": {
          "EuroClearSectorCode": "144200"
        },
        "GlobalFinancialInformation": {
          "AnnualIncomeAfterTax": {
            "Amount": 100020,
            "AmountDescription": "Exact",
            "CurrencyCode": "DKK"
          },
          "IntendToInvest": {
            "Amount": 1000000,
            "AmountDescription": "AboveThisAmount",
            "CurrencyCode": "DKK"
          },
          "InvestableAsset": {
            "Amount": 1000000,
            "AmountDescription": "Rounded",
            "CurrencyCode": "DKK"
          }
        },
        "HongkongData": {
          "NetWorthInUsd": "2",
          "TotalEstimatedAnnualIncomeInUsd": "4"
        },
        "JapanData": {
          "AnnualIncomeJpy": "3",
          "NetWorthJpy": "5",
          "TickerCodes": [
            "6234",
            "0392",
            "1025"
          ]
        },
        "PersonalInformation": {
          "AdditionalNationalities": [
            {
              "CountryCode": "UK",
              "NationalId": "38992710",
              "NationalIdType": 4
            }
          ],
          "AdditionalTaxableCountries": [
            {
              "CountryCode": "SG",
              "TaxId": "1231314",
              "TinNotAvailable": false
            }
          ],
          "AliasFirstName": "Alice",
          "AliasLastName": "Joe",
          "CityOfBirth": "Test Birth City",
          "ContactInformation": {
            "EmailAddress": "email1_9534299@email.com",
            "MobileNumber": {
              "CountryCode": "DK",
              "Number": "5236254126"
            },
            "PrimaryPhoneNumber": {
              "CountryCode": "DK",
              "Number": "355354654"
            },
            "SecondaryPhoneNumber": {
              "CountryCode": "DK",
              "Number": "989899797"
            }
          },
          "CountryOfBirth": "DK",
          "DateOfBirth": "1994-04-12T00:00:00Z",
          "EmploymentInformation": {
            "EmployerName": "Test Employer",
            "NatureOfBusiness": "10",
            "OccupationTypes": [
              "1",
              "2",
              "3"
            ],
            "Position": "Test Position"
          },
          "FirstName": "First9534299",
          "LastName": "Last9534299",
          "MinorInformation": {
            "MinorLegalGuardianship": "Sharedwithanotherlegalguardian",
            "OtherReason": "None",
            "SharedResponsibilityWithLegalGuardian": "2451ac4b-e2d3-47d9-9d88-db00a056d365",
            "SharedResponsibilityWithLegalGuardianLoginUserId": "6372920",
            "SharedResponsibilityWithLegalGuardianName": "Guardian"
          },
          "NationalityCode": "DK",
          "NinMissingReason": "ODDCollection",
          "NinMissingType": "TaxID",
          "NinNotAvailable": true,
          "OriginalScriptFirstName": "比",
          "OriginalScriptLastName": "伊",
          "OtherAddress": {
            "BuildingName": "Test Building",
            "BuildingNumber": "420",
            "City": "Test Address City",
            "CoName": "CO Test",
            "CountryOfResidenceCode": "IN",
            "Floor": "5",
            "LocalArea": "Local Test Area",
            "PostalCode": "123466",
            "PostBoxOffice": "212313",
            "SideDoor": "Test SideDoor",
            "State": "Test State",
            "StreetName": "Test Street",
            "Unit": "Unit 10"
          },
          "PersonalId": "4499647",
          "PersonalIdExpirationDate": "2027-01-07T00:00:00Z",
          "PersonalIdPlaceOfRelease": "Milan",
          "PersonalIdReleaseDate": "2016-12-08T00:00:00Z",
          "PersonalIdReleasedBy": "John doe",
          "PersonalIdType": "1",
          "PoliticallyExposedInformation": {
            "PepRelatedPersonName": "Fred XXX",
            "PepRelatedPersonPosition": "Director",
            "PepType": "2",
            "RelationToPep": "5"
          },
          "PoliticallyExposedPerson": true,
          "ResidentialAddress": {
            "BuildingName": "Test Building",
            "BuildingNumber": "420",
            "City": "Test Address City",
            "CoName": "CO Test",
            "CountryOfResidenceCode": "IN",
            "Floor": "5",
            "LocalArea": "Local Test Area",
            "PostalCode": "123466",
            "PostBoxOffice": "212313",
            "SideDoor": "Test SideDoor",
            "State": "Test State",
            "StreetName": "Test Street",
            "Unit": "Unit 10"
          },
          "TaxId": "5454898",
          "TinMissingReason": "100000003",
          "TinNotAvailable": true
        },
        "ProfileInformation": {
          "AmlTmInformation": {
            "AmlType": [
              "AmlSurveillanceFinancial"
            ],
            "JurisdictionAnswer": "",
            "QuestionedJurisdiction": [
              ""
            ]
          },
          "AnnualIncomeInformation": {
            "AnnualSalaryAfterTax": "11",
            "SecondaryIncomeOther": "1",
            "SecondarySourcesOfIncome": [
              "3"
            ],
            "SecondarySourcesOfIncomeTotal": "9"
          },
          "FundingInformation": {
            "FundingLimitConsumed": 0.9
          },
          "InvestableAssets": {
            "IntendToInvest": "13",
            "PrimarySourcesOfWealth": [
              "2",
              "3"
            ],
            "SourceOfWealthOther": "Other Wealth",
            "ValueOfCashAndSecurities": "11"
          },
          "TradingProfile": {
            "SoleBoOfAssets": false
          }
        },
        "RegulatoryInformation": {
          "FatcaDeclaration": {
            "UnitedStatesCitizen": true,
            "UnitedStatesTaxId": "456123",
            "UnitedStatesTaxLiable": true
          }
        },
        "Relationships": [
          {
            "AdditionalCustomerName": "XMAJO",
            "AdditionalLoginUserId": "76514",
            "OtherReason": "OtherReason",
            "RelationshipStatus": "Valid",
            "RelationshipType": "JAHolder",
            "RelationWithPrimaryLoginUser": "Other"
          }
        ],
        "SingaporeData": {
          "AccreditedInvestor": false,
          "AnnualIncomeSgd": "3",
          "NetWorthSgd": "5"
        },
        "SwitzerlandData": {
          "AnnualIncomeChf": "3",
          "NetWorthChf": "5"
        },
        "UkData": {
          "EstimatedSavingAndInvestmentGbp": "14500",
          "MonthlyIncomeAfterTaxGbp": "42000"
        }
      }
    }