Skip to main content

Settings

Overview​

The Settings API provides endpoints for managing system configuration data, including countries, employment types, document requirements, transaction types, and risk settings. These endpoints allow partners to retrieve and manage their specific configurations.

Base Endpoint​

GET/POST/PUT /settings

Authentication​

All endpoints require a valid JWT Bearer token in the Authorization header:

Authorization: Bearer <your_jwt_token>

Endpoints​

Countries​

Get Countries​

Retrieve all countries with optional filtering.

Endpoint: GET /settings/countries

Query Parameters:

  • isActive (optional): Filter by active status

Response:

[
  {
    "countriesID": 118,
    "companyCountryRisk": null,
    "countryCode": "VI",
    "countryName": "U.S. Virgin Islands",
    "countryRiskScore": 2,
    "fatfCountry": false,
    "isActive": true,
    "adminUpdated": 1,
    "dateUpdated": "2020-01-27T00:00:00.000Z",
    "partnerGUID": null
  }
]

Get Country by ID​

Retrieve a specific country by ID.

Endpoint: GET /settings/countries/{countriesID}

Path Parameters:

  • countriesID (required): Country ID

Create/Update Country​

Create or update a country record.

Endpoint: POST /settings/countries

Request Body:

{
  "countriesID": 103,
  "countryName": "Isle of Man",
  "countryCode": "IM",
  "companyCountryRisk": "Low Risk",
  "countryRiskScore": 2,
  "isActive": true,
  "fatfCountry": false,
  "partnerGUID": null
}

Employment Industries​

Get Employment Industries​

Retrieve all employment industries.

Endpoint: GET /settings/employmentIndustries

Response:

[
  {
    "EmploymentIndustryID": 14,
    "EmploymentIndustryDesc": "Activities of religious, political and extraterritorial organisations/bodies",
    "EmploymentIndustryRiskScore": 15,
    "IsActive": true,
    "userUpdated": 757,
    "DateUpdated": "2024-03-06T12:17:00.000Z",
    "RequireAdditionalQuestions": false,
    "partnerGUID": null
  }
]

Get Employment Industry by ID​

Retrieve a specific employment industry by ID.

Endpoint: GET /settings/employmentIndustries/{employmentIndustryID}

Create/Update Employment Industry​

Create or update an employment industry record.

Endpoint: POST /settings/employmentIndustries

Request Body:

{
  "EmploymentIndustryID": 9,
  "EmploymentIndustryDesc": "All security, safety and defense activities (Private or Government)",
  "EmploymentIndustryRiskScore": 15,
  "IsActive": true,
  "RequireAdditionalQuestions": false,
  "partnerGUID": null
}

Employment Types​

Get Employment Types​

Retrieve all employment types.

Endpoint: GET /settings/employmentTypes

Response:

[
  {
    "EmploymentTypeId": 4,
    "EmploymentTypeDesc": "Retired",
    "IsActive": true,
    "AdminUpdated": 1,
    "DateUpdated": "2020-01-27T00:00:00.000Z",
    "EmploymentTypeRisk": 1,
    "RequireAdditionalQuestions": false,
    "partnerGUID": null
  }
]

Get Employment Type by ID​

Retrieve a specific employment type by ID.

Endpoint: GET /settings/employmentTypes/{employmentTypeId}

Create/Update Employment Type​

Create or update an employment type record.

Endpoint: POST /settings/employmentTypes

Request Body:

{
  "EmploymentTypeId": 2,
  "EmploymentTypeDesc": "Salaried",
  "EmploymentTypeRisk": 1,
  "RequireAdditionalQuestions": true,
  "IsActive": true,
  "partnerGUID": null
}

Individual Documents​

Get Individual Documents​

Retrieve all individual document requirements with optional filtering.

Endpoint: GET /settings/individualDocs

Query Parameters:

  • orderBy (optional): Sort order - asc or desc
  • orderByField (optional): Field to sort by
  • docName (optional): Filter by document name
  • docRequiredLowRisk (optional): Filter by low risk description
  • docRequiredMediumRisk (optional): Filter by medium risk description
  • docRequiredHighRisk (optional): Filter by high risk description
  • docCheckDesc (optional): Filter by check description
  • isActive (optional): Filter by active status
  • lowRiskRequiredDoc (optional): Filter by low risk required
  • mediumRiskRequiredDoc (optional): Filter by medium risk required
  • highRiskRequired (optional): Filter by high risk required
  • pepRequiredDoc (optional): Filter by PEP required
  • ftrRequiredDoc (optional): Filter by FTR required
  • trustRelatedPartyRequired (optional): Filter by trust related party required
  • showUBO (optional): Filter by UBO show status
  • uboIndividualHighRisk (optional): Filter by UBO individual high risk
  • uboTrustHighRisk (optional): Filter by UBO trust high risk

Response:

[
  {
    "individualDocsID": 1,
    "chkbxDocCheckName": "chkbxDocIdentity",
    "docName": "Identity",
    "docRequiredHighRisk": "Copy of ID Document original sighted",
    "docRequiredLowRisk": "Copy of ID Document",
    "docCheckDesc": "ID Number given by Client corresponds to ID number on documentation",
    "selectDocTypeName": "identityDocSelect",
    "highRiskRequired": true,
    "lowRiskRequiredDoc": true,
    "pepRequiredDoc": true,
    "isActive": true,
    "lastUpdateAdminID": 1,
    "lastUpdateDate": "2024-04-23T09:57:00.000Z",
    "adminAddedID": null,
    "adminAddedDate": null,
    "additionalDocs": "false",
    "ftrRequiredDoc": false,
    "showUBO": true,
    "showTrustRelatedParty": true,
    "trustRelatedPartyRequired": true,
    "IndividualDoc": true,
    "uboIndividualHighRisk": true,
    "uboTrustHighRisk": true,
    "mediumRiskRequiredDoc": true,
    "partnerGUID": null,
    "docRequiredMediumRisk": "Copy of ID Document"
  }
]

Get Individual Document Types​

Retrieve document types for a specific individual document.

Endpoint: GET /settings/individualDocs/{individualDocsID}/docTypes

Path Parameters:

  • individualDocsID (required): Individual document ID

Response:

[
  {
    "IndividualDocTypesID": 1,
    "docTypeDesc": "RSA ID Book",
    "docTypeName": "rsaIDBook",
    "individualDocsID": 1,
    "isActive": true,
    "adminAddedID": null,
    "adminAddedDate": null,
    "adminUpdatedID": null,
    "adminUpdatedDate": null,
    "partnerGUID": null
  }
]

Create/Update Individual Document​

Create or update an individual document requirement.

Endpoint: POST /settings/individualDocs

Request Body:

{
  "individualDocsID": 1,
  "docName": "Identity",
  "docRequiredHighRisk": "Copy of ID Document original sighted",
  "docRequiredMediumRisk": "Copy of ID Document",
  "docRequiredLowRisk": "Copy of ID Document",
  "docCheckDesc": "ID Number given by Client corresponds to ID number on documentation",
  "selectDocTypeName": "identityDocSelect",
  "highRiskRequired": true,
  "lowRiskRequiredDoc": true,
  "mediumRiskRequiredDoc": true,
  "pepRequiredDoc": true,
  "ftrRequiredDoc": false,
  "showUBO": true,
  "showTrustRelatedParty": true,
  "trustRelatedPartyRequired": true,
  "IndividualDoc": true,
  "uboIndividualHighRisk": true,
  "uboTrustHighRisk": true,
  "isActive": true,
  "partnerGUID": null,
  "additionalDocs": "false"
}

Create/Update Individual Document Type​

Create or update an individual document type.

Endpoint: POST /settings/individualDocTypes

Request Body:

{
  "IndividualDocTypesID": 235,
  "docTypeDesc": "SA Green ID Book",
  "docTypeName": "SA Green ID Book",
  "individualDocsID": 1,
  "isActive": true
}

Entity Industries​

Get Entity Industries​

Retrieve all entity industries with optional filtering.

Endpoint: GET /settings/entityIndustries

Query Parameters:

  • orderBy (optional): Sort order - asc or desc
  • orderByField (optional): Field to sort by
  • take (optional): Number of records to return
  • skip (optional): Number of records to skip
  • EntityIndustryDesc (optional): Filter by description
  • EntityIndustryRiskScore (optional): Filter by risk score
  • RequireAdditionalQuestions (optional): Filter by additional questions required
  • IsActive (optional): Filter by active status

Response:

{
  "count": 17,
  "data": [
    {
      "CompanyIndustryId": 1,
      "IsActive": true,
      "AdminUpdated": 1,
      "DateUpdated": "2020-01-27T00:00:00.000Z",
      "EntityIndustryDesc": "Other",
      "EntityIndustryRiskScore": 2,
      "RequireAdditionalQuestions": true,
      "partnerGUID": null
    }
  ]
}

Get Entity Industry by ID​

Retrieve a specific entity industry by ID.

Endpoint: GET /settings/entityIndustries/{companyIndustryId}

Create/Update Entity Industry​

Create or update an entity industry record.

Endpoint: POST /settings/entityIndustries

Request Body:

{
  "CompanyIndustryId": 7,
  "EntityIndustryDesc": "Extraction of crude petroleum, natural gas",
  "EntityIndustryRiskScore": 5,
  "IsActive": true,
  "RequireAdditionalQuestions": false,
  "partnerGUID": null
}

Entity Types​

Get Entity Types​

Retrieve all entity types with optional filtering.

Endpoint: GET /settings/entityTypes

Query Parameters:

  • orderBy (optional): Sort order - asc or desc
  • orderByField (optional): Field to sort by
  • take (optional): Number of records to return
  • skip (optional): Number of records to skip
  • EntityTypeDesc (optional): Filter by description
  • EntityTypeRiskScore (optional): Filter by risk score
  • RequireAdditionalQuestions (optional): Filter by additional questions required
  • showOrganigram (optional): Filter by organigram show status
  • IsActive (optional): Filter by active status

Response:

{
  "count": 20,
  "data": [
    {
      "EntityTypeID": 1,
      "EntityTypeDesc": "Public Company - Ltd.",
      "EntityTypeRiskScore": 1,
      "IsActive": true,
      "AdminUpdated": 792,
      "DateUpdated": "2024-04-22T10:42:00.000Z",
      "RequireAdditionalQuestions": false,
      "CIPCcode": true,
      "showOrganigram": false,
      "partnerGUID": null
    }
  ]
}

Get Entity Type by ID​

Retrieve a specific entity type by ID.

Endpoint: GET /settings/entityTypes/{entityTypeID}

Create/Update Entity Type​

Create or update an entity type record.

Endpoint: POST /settings/entityTypes

Request Body:

{
  "EntityTypeID": 5,
  "EntityTypeDesc": "Close Corporation- CC",
  "EntityTypeRiskScore": 1,
  "IsActive": true,
  "RequireAdditionalQuestions": false,
  "showOrganigram": false,
  "partnerGUID": null
}

Get All Entity Types​

Retrieve all entity types for a partner.

Endpoint: GET /settings/getAllEntityTypes

Transaction Types​

Get Transaction Types​

Retrieve all transaction types.

Endpoint: GET /settings/transactionTypes

Response:

[
  {
    "TransactionTypesId": 103,
    "TransactionTypesDesc": "Annual Financial Statements",
    "TransactionTypesRiskScore": 1,
    "IsActive": true,
    "AdminUpdated": 8,
    "DateUpdated": "2024-05-22T13:37:00.000Z",
    "active": null,
    "partnerGUID": null
  }
]

Get Transaction Type by ID​

Retrieve a specific transaction type by ID.

Endpoint: GET /settings/transactionTypes/{transactionTypesId}

Create/Update Transaction Type​

Create or update a transaction type record.

Endpoint: POST /settings/transactionTypes

Request Body:

{
  "TransactionTypesId": 3467,
  "TransactionTypesDesc": "Forex - Foreign Investment Allowance",
  "TransactionTypesRiskScore": 1,
  "IsActive": true,
  "partnerGUID": "90808e78-ccff-4783-9ee0-6466486a7876",
  "active": null
}

Transaction Frequencies​

Get Transaction Frequencies​

Retrieve all transaction frequencies.

Endpoint: GET /settings/transactionFrequencies

Response:

[
  {
    "TransactionFrequencyId": 2,
    "TransactionFrequencyDesc": "Multiple Transaction",
    "TransactionFrequencyRiskScore": 2,
    "IsActive": true,
    "AdminUpdated": 8,
    "DateUpdated": "2025-01-17T11:27:00.000Z",
    "partnerGUID": null
  }
]

Get Transaction Frequency by ID​

Retrieve a specific transaction frequency by ID.

Endpoint: GET /settings/transactionFrequencies/{TransactionFrequencyId}

Create/Update Transaction Frequency​

Create or update a transaction frequency record.

Endpoint: POST /settings/transactionFrequencies

Request Body:

{
  "TransactionFrequencyId": 18,
  "TransactionFrequencyDesc": "Monthly Transaction",
  "TransactionFrequencyRiskScore": 2,
  "IsActive": true
}

Transaction Funding​

Get Transaction Funding​

Retrieve all transaction funding sources.

Endpoint: GET /settings/transactionFunding

Response:

[
  {
    "transactionFundingID": 4,
    "transactionFundingSourceDesc": "Allowance",
    "transactionFundingSourceRiskScore": 1,
    "isActive": true,
    "adminUpdated": 1,
    "dateUpdated": "2024-03-06T14:17:00.000Z",
    "requireAdditionalQuestions": false,
    "entityIsActive": false,
    "trustIsActive": true,
    "estateLateIsActive": false,
    "active": true,
    "additionalQuestions": false,
    "entityActive": false,
    "trustActive": false,
    "estateLateActive": false,
    "transactionFundingDesc": "Allowance",
    "partnerGUID": null
  }
]

Get Active Transaction Funding​

Retrieve active transaction funding by ID.

Endpoint: GET /settings/transactionFunding/{transactionFundingID}/active

Create Transaction Funding​

Create a new transaction funding source.

Endpoint: POST /settings/transactionFunding

Request Body:

{
  "transactionFundingID": 743,
  "transactionFundingSourceDesc": "Allowance",
  "transactionFundingSourceRiskScore": 1,
  "entityIsActive": true,
  "trustIsActive": true,
  "estateLateIsActive": false,
  "requireAdditionalQuestions": true,
  "isActive": true,
  "partnerGUID": "90808e78-ccff-0000-9ee0-6466486a7876"
}

Wealth Sources​

Get Wealth Sources​

Retrieve all wealth sources.

Endpoint: GET /settings/wealthSources

Response:

[
  {
    "wealthSourceID": 4,
    "individualWealthSourceDesc": "Allowance",
    "individualWealthSourceRiskScore": 1,
    "isActive": true,
    "adminUpdated": 1,
    "dateUpdated": "2020-01-27T00:00:00.000Z",
    "requireAdditionalQuestions": false,
    "entityIsActive": false,
    "trustIsActive": true,
    "estateLateIsActive": false,
    "active": true,
    "additionalQuestions": false,
    "entityActive": false,
    "trustActive": false,
    "estateLateActive": false,
    "wealthSourceDesc": "Allowance",
    "partnerGUID": null
  }
]

Get Wealth Source by ID​

Retrieve a specific wealth source by ID.

Endpoint: GET /settings/wealthSources/{wealthSourceID}

Create/Update Wealth Source​

Create or update a wealth source record.

Endpoint: POST /settings/wealthSources

Request Body:

{
  "wealthSourceID": 653,
  "individualWealthSourceDesc": "Company Profits",
  "individualWealthSourceRiskScore": 1,
  "isActive": true,
  "requireAdditionalQuestions": false,
  "entityIsActive": true,
  "trustIsActive": true,
  "estateLateIsActive": false,
  "partnerGUID": "90808e78-ccff-0000-9ee0-6466486a7876"
}

Public Official Types​

Get Public Official Types​

Retrieve all public official types.

Endpoint: GET /settings/publicOfficialTypes

Response:

[
  {
    "PublicOfficialTypeId": 11,
    "FppoDescription": "Ambassadors, members of boards of central banks",
    "FppoRiskScore": 8,
    "FppoType": "Foreign",
    "IsActive": true,
    "AdminUpdated": 1,
    "DateUpdated": "2024-04-22T10:19:38.733Z",
    "partnerGUID": null
  }
]

Get Active Public Official Type​

Retrieve an active public official type by ID.

Endpoint: GET /settings/publicOfficialTypes/{publicOfficialTypeId}/active

Create/Update Public Official Type​

Create or update a public official type record.

Endpoint: POST /settings/publicOfficialTypes

Request Body:

{
  "PublicOfficialTypeId": 107,
  "FppoDescription": "Ambassadors, members of boards of central banks",
  "FppoRiskScore": 8,
  "FppoType": "Foreign",
  "IsActive": true,
  "partnerGUID": "90808e78-ccff-0000-9ee0-6466486a7876"
}

Entity Documents​

Get Entity Documents​

Retrieve all entity document requirements with optional filtering.

Endpoint: GET /settings/entityDocs

Query Parameters:

  • orderBy (optional): Sort order - asc or desc
  • orderByField (optional): Field to sort by
  • docName (optional): Filter by document name
  • docRequiredLowRisk (optional): Filter by low risk description
  • docRequiredHighRisk (optional): Filter by high risk description
  • docRequiredMediumRisk (optional): Filter by medium risk description
  • docCheckDesc (optional): Filter by check description
  • isActive (optional): Filter by active status
  • lowRiskRequiredDoc (optional): Filter by low risk required
  • mediumRiskRequiredDoc (optional): Filter by medium risk required
  • highRiskRequired (optional): Filter by high risk required
  • pepRequiredDoc (optional): Filter by PEP required

Response:

[
  {
    "entityDocsID": 1,
    "chkbxDocCheckName": "companyRegistrationCheckBoxDocVerified",
    "docName": "Proof of incorporation",
    "docRequiredHighRisk": "Proof of incorporation original sighted",
    "docRequiredLowRisk": "Proof of incorporation",
    "docCheckDesc": "Company registration number corresponds to company number entered",
    "selectDocTypeName": "companyRegistrationSelectDocTypes",
    "highRiskRequired": false,
    "lowRiskRequiredDoc": false,
    "pepRequiredDoc": false,
    "isActive": true,
    "lastUpdateAdminID": 1,
    "lastUpdateDate": "2024-04-22T10:11:00.000Z",
    "adminAddedID": 1,
    "adminAddedDate": null,
    "partnerGUID": null,
    "docRequiredMediumRisk": "Proof of incorporation",
    "mediumRiskRequiredDoc": false
  }
]

Get Entity Document Types​

Retrieve document types for a specific entity document.

Endpoint: GET /settings/entityDocs/{entityDocsID}/docTypes

Path Parameters:

  • entityDocsID (required): Entity document ID

Create/Update Entity Document​

Create or update an entity document requirement.

Endpoint: POST /settings/entityDocs

Request Body:

{
  "entityDocsID": 191,
  "docName": "Company Registration",
  "docRequiredHighRisk": "Company Registration",
  "docRequiredMediumRisk": "Company Registration",
  "docRequiredLowRisk": "Company Registration",
  "docCheckDesc": "Company Registration",
  "lowRiskRequiredDoc": false,
  "mediumRiskRequiredDoc": false,
  "highRiskRequired": true,
  "pepRequiredDoc": true,
  "isActive": true,
  "partnerGUID": "90808e78-ccff-0000-9ee0-6466486a7876"
}

Create/Update Entity Document Type​

Create or update an entity document type.

Endpoint: POST /settings/entityDocTypes

Request Body:

{
  "entityDocTypesID": 135,
  "docTypeDesc": "CIPC Registration Document",
  "docTypeName": "Cipc Docs",
  "entityDocsID": 191,
  "isActive": true,
  "partnerGUID": "90808e78-ccff-0000-9ee0-6466486a7876"
}

Trust Documents​

Get Trust Documents​

Retrieve all trust document requirements with optional filtering.

Endpoint: GET /settings/trustDocs

Query Parameters:

  • orderBy (optional): Sort order - asc or desc
  • orderByField (optional): Field to sort by
  • docName (optional): Filter by document name
  • docRequiredLowRisk (optional): Filter by low risk description
  • docRequiredMediumRisk (optional): Filter by medium risk description
  • docRequiredHighRisk (optional): Filter by high risk description
  • docCheckDesc (optional): Filter by check description
  • isActive (optional): Filter by active status
  • lowRiskRequiredDoc (optional): Filter by low risk required
  • mediumRiskRequiredDoc (optional): Filter by medium risk required
  • highRiskRequired (optional): Filter by high risk required
  • pepRequiredDoc (optional): Filter by PEP required
  • ftrRequiredDoc (optional): Filter by FTR required
  • showUBO (optional): Filter by UBO show status

Response:

[
  {
    "trustDocsID": 1,
    "chkbxDocCheckName": null,
    "docName": "Trust Deeds",
    "docRequiredHighRisk": "Certified copy of Trust Deeds and Amendments",
    "docRequiredLowRisk": "Certified copy of Trust Deeds and Amendments",
    "docCheckDesc": "Certified copy of Trust Deeds and Amendments",
    "selectDocTypeName": "trustDeeds",
    "highRiskRequired": true,
    "lowRiskRequiredDoc": true,
    "pepRequiredDoc": true,
    "isActive": true,
    "lastUpdateAdminID": 1,
    "lastUpdateDate": "2024-05-02T09:03:00.000Z",
    "adminAddedID": null,
    "adminAddedDate": null,
    "additionalDocs": "false",
    "ftrRequiredDoc": "false",
    "showUBO": null,
    "partnerGUID": null,
    "docRequiredMediumRisk": "Certified copy of Trust Deeds and Amendments",
    "mediumRiskRequiredDoc": true
  }
]

Get Trust Document Types​

Retrieve document types for a specific trust document.

Endpoint: GET /settings/trustDocs/{trustDocsID}/docTypes

Path Parameters:

  • trustDocsID (required): Trust document ID

Create/Update Trust Document​

Create or update a trust document requirement.

Endpoint: POST /settings/trustDocs

Request Body:

{
  "trustDocsID": 132,
  "docName": "Trust Deeds",
  "docRequiredHighRisk": "Certified copy of Trust Deeds and Amendments",
  "docRequiredMediumRisk": "Certified copy of Trust Deeds and Amendments",
  "docRequiredLowRisk": "Certified copy of Trust Deeds and Amendments",
  "docCheckDesc": "Certified copy of Trust Deeds and Amendments",
  "lowRiskRequiredDoc": true,
  "mediumRiskRequiredDoc": true,
  "highRiskRequired": true,
  "pepRequiredDoc": true,
  "isActive": true,
  "partnerGUID": "partnerGUID"
}

Create/Update Trust Document Type​

Create or update a trust document type.

Endpoint: POST /settings/trustDocTypes

Request Body:

{
  "trustDocTypesID": 66,
  "docTypeDesc": "New Sub doc type description",
  "docTypeName": "",
  "trustDocsID": 132,
  "isActive": true
}

Trust Masters Courts​

Get Trust Masters Courts​

Retrieve all trust masters courts with optional filtering.

Endpoint: GET /settings/trustMastersCourts

Query Parameters:

  • orderBy (optional): Sort order - asc or desc
  • orderByField (optional): Field to sort by
  • take (optional): Number of records to return
  • skip (optional): Number of records to skip
  • trustMastersCourtName (optional): Filter by court name
  • detailsRequired (optional): Filter by details required status
  • isActive (optional): Filter by active status

Response:

[
  {
    "trustMastersCourtID": 1,
    "trustMastersCourtGUID": "51d1e754-ef82-46ec-8a3f-5f1a189a4ce4",
    "trustMastersCourtName": "Bisho Masters Office",
    "isActive": true,
    "adminAddedID": null,
    "adminAddedDate": null,
    "adminEditedID": null,
    "adminEditedDate": null,
    "dogID": 637,
    "detailsRequired": "false"
  }
]

Create/Update Trust Masters Court​

Create or update a trust masters court record.

Endpoint: POST /settings/trustMastersCourts

Request Body:

{
  "trustMastersCourtID": 1,
  "trustMastersCourtName": "Bisho Masters Office",
  "isActive": true,
  "detailsRequired": "false"
}

Risk Values​

Get Risk Values​

Retrieve risk values for a specific partner.

Endpoint: GET /settings/riskValues/{partnerID}

Path Parameters:

  • partnerID (required): Partner ID

Response:

{
  "partnerID": 1,
  "isActive": true,
  "createdAdminID": 1,
  "createdDate": "2024-05-16T12:05:00.000Z",
  "updatedAdminID": 1,
  "updatedDate": "2024-10-18T13:01:00.000Z",
  "highRiskScoreIndividual": 15,
  "highRiskScoreTrust": 15,
  "highRiskScoreEntity": 15,
  "highRiskScoreIndividualOrganigram": 0,
  "highRiskScoreEntityOrganigram": 7,
  "highRiskScoreEntityIndividual": 10,
  "highRiskScoreTrustRelatedParty": 15,
  "mediumRiskScoreIndividual": 10,
  "mediumRiskScoreTrust": 10,
  "mediumRiskScoreEntity": 8,
  "mediumRiskScoreIndividualOrganigram": 0,
  "mediumRiskScoreEntityOrganigram": 6,
  "mediumRiskScoreTrustRelatedParty": 8,
  "mediumRiskScoreEntityIndividual": 7,
  "highRiskScoreEntityUBOPercent": 10,
  "mediumRiskScoreEntityUBOPercent": 25,
  "lowRiskScoreEntityUBOPercent": 25,
  "usingDefaultValues": false
}

Create/Update Risk Values​

Create or update risk values for a partner.

Endpoint: POST /settings/riskValues

Request Body:

{
  "partnerID": 0,
  "isActive": true,
  "highRiskScoreIndividual": 15,
  "highRiskScoreTrust": 15,
  "highRiskScoreEntity": 15,
  "highRiskScoreIndividualOrganigram": 0,
  "highRiskScoreEntityOrganigram": 10,
  "highRiskScoreEntityIndividual": 10,
  "highRiskScoreTrustRelatedParty": 10,
  "mediumRiskScoreIndividual": 10,
  "mediumRiskScoreTrust": 10,
  "mediumRiskScoreEntity": 8,
  "mediumRiskScoreIndividualOrganigram": 0,
  "mediumRiskScoreEntityOrganigram": 6,
  "mediumRiskScoreTrustRelatedParty": 5,
  "mediumRiskScoreEntityIndividual": 5,
  "highRiskScoreEntityUBOPercent": 5,
  "mediumRiskScoreEntityUBOPercent": 5,
  "lowRiskScoreEntityUBOPercent": 5
}

Revert Risk Values​

Revert risk values to defaults for a partner.

Endpoint: DELETE /settings/riskValues/{partnerID}

Path Parameters:

  • partnerID (required): Partner ID to revert

Terms and Conditions​

Get TAC​

Retrieve terms and conditions.

Endpoint: GET /settings/tac

Get Partner TAC​

Retrieve partner-specific terms and conditions.

Endpoint: GET /settings/tacPartner

Get Admin TAC​

Retrieve admin terms and conditions.

Endpoint: GET /settings/tacAdmin

Update TAC​

Update terms and conditions.

Endpoint: POST /settings/tac

Request Body:

{
  "tactype": "partner",
  "TAC": "Updated terms and conditions text"
}

Pricing Values​

Get Pricing Values​

Retrieve pricing values for a specific partner.

Endpoint: GET /settings/pricingValues/{partnerID}

Path Parameters:

  • partnerID (required): Partner ID

Create/Update Pricing Values​

Create or update pricing values for a partner.

Endpoint: POST /settings/pricingValues

Request Body:

{
  "partnerID": 1,
  "isActive": true,
  "individualPrice": 100,
  "uboLevelOneQty": 5,
  "uboLevelTwoQty": 10,
  "uboLevelThreeQty": 15,
  "uboLevelOnePrice": 50,
  "uboLevelTwoPrice": 75,
  "uboLevelThreePrice": 100,
  "uboLevelFourPrice": 125
}

Revert Pricing Values​

Revert pricing values to defaults for a partner.

Endpoint: DELETE /settings/pricingValues/{partnerID}

Path Parameters:

  • partnerID (required): Partner ID to revert

System Email Addresses​

Get System Email Addresses​

Retrieve system email addresses.

Endpoint: GET /settings/systemEmailAddresses

Update System Email Addresses​

Update system email addresses.

Endpoint: POST /settings/systemEmailAddresses

Request Body:

{
  "globalSettingsID": 1,
  "charterForexEmail": "forex@charter.co.za",
  "forwardToCharterEmailAddress": "charter@efica.co.za",
  "systememailaddress": "system@efica.co.za"
}

Error Responses​

400 Bad Request​

{
  "message": "Invalid request parameters",
  "statusCode": 400
}

401 Unauthorized​

{
  "message": "Invalid or missing authentication token",
  "statusCode": 401
}

403 Forbidden​

{
  "message": "Access denied",
  "statusCode": 403
}

404 Not Found​

{
  "message": "Record not found",
  "statusCode": 404
}

500 Internal Server Error​

{
  "message": "Internal server error",
  "statusCode": 500
}

Notes​

  • All dates are returned in ISO 8601 format (UTC)
  • Partner-specific settings override global settings
  • Risk scores are used for automated risk assessment
  • Document requirements vary by risk level (low, medium, high)
  • Some endpoints require admin or higher privileges.
  • Partner GUID is used to scope partner-specific configurations

Last Updated: 14 August 2025