Action: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingtype/get | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch a Static Onboarding Type record based on Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | OnboardingTypeID | Int16 | OnboardingType Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | IncludeDataCollectionLogo | Boolean | Include Data Collection Logo (optional default is FALSE) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Onboarding Type record. { "OnboardingTypeID": 200, "OnboardingTypeName": "Person", "OnboardingTypeDescription": "Person Gibraltar", "LowRiskIDPalProfileType": 632, "StandardRiskIDPalProfileType": 632, "HighRiskIDPalProfileType": 632, "VeryHighRiskIDPalProfileType": 632, "LowRiskOnboardingApprovalType": 0, "StandardRiskOnboardingApprovalType": 0, "HighRiskOnboardingApprovalType": 0, "VeryHighRiskOnboardingApprovalType": 0, "LowRiskCriteriaID": 1, "StandardRiskCriteriaID": 40, "HighRiskCriteriaID": 39, "VeryHighRiskCriteriaID": 39, "LowRiskClientEntityRiskID": 1, "StandardRiskClientEntityRiskID": 2, "HighRiskClientEntityRiskID": 3, "VeryHighRiskClientEntityRiskID": 3, "ExcludeOnboardingStageDataCollection": false, "ExcludeOnboardingStageDataApproval": false, "ExcludeOnboardingStageIdentityVerification": false, "ExcludeOnboardingStageIdentityApproval": false, "ExcludeOnboardingStageScreening": false, "ExcludeOnboardingStageComplianceApproval": false, "NomineeDataCollectionType": 0, "DataCollectionWelcomeMessage": "Welcome to RiskScreen Onboard. Please complete this form and submit.", "DataCollectionLogo": null, "DataCollectionLogoThumbnail": null, "DataCollectionLogoMediaType": "image/png", "RiskModelType": 0, "LowWeightedRiskScoreUpperLimit": 25, "StandardWeightedRiskScoreUpperLimit": 50, "HighWeightedRiskScoreUpperLimit": 75, "VeryHighWeightedRiskScoreUpperLimit": 100 "TermsAndConditionsEnabled": false, "TermsAndConditionsMessage": "", "LowRiskCriteriaName": "Person", "StandardRiskCriteriaName": "Person", "HighRiskCriteriaName": "Person High Risk", "VeryHighRiskCriteriaName": "Person High Risk", "EmailTemplateID": [56,59], "SnapshotType": 0 } |
|
Action: | GET ALL | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingtype/getall | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch all Static Onboarding Type records | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | IncludeDataCollectionLogo | Boolean | Include Data Collection Logo (optional default is FALSE) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML collection of Static Onboarding Type records. [{ "OnboardingTypeID": 200, "OnboardingTypeName": "Person", "OnboardingTypeDescription": "Person Gibraltar", "LowRiskIDPalProfileType": 632, "StandardRiskIDPalProfileType": 632, "HighRiskIDPalProfileType": 632, "VeryHighRiskIDPalProfileType": 632, "LowRiskOnboardingApprovalType": 0, "StandardRiskOnboardingApprovalType": 0, "HighRiskOnboardingApprovalType": 0, "VeryHighRiskOnboardingApprovalType": 0, "LowRiskCriteriaID": 1, "StandardRiskCriteriaID": 40, "HighRiskCriteriaID": 39, "VeryHighRiskCriteriaID": 39, "LowRiskClientEntityRiskID": 1, "StandardRiskClientEntityRiskID": 2, "HighRiskClientEntityRiskID": 3, "VeryHighRiskClientEntityRiskID": 3, "ExcludeOnboardingStageDataCollection": false, "ExcludeOnboardingStageDataApproval": false, "ExcludeOnboardingStageIdentityVerification": false, "ExcludeOnboardingStageIdentityApproval": false, "ExcludeOnboardingStageScreening": false, "ExcludeOnboardingStageComplianceApproval": false, "NomineeDataCollectionType": 0, "EmailAlertDisabled": false, "EmailAlertToAllSupervisors": false, "EmailAlertToAllManagers": false, "EmailAlertToAllDirectors": false, "LeadProspectApprovalType": 0, "DataCollectionWelcomeMessage": "Welcome to RiskScreen Onboard. Please complete this form and submit.", "DataCollectionLogo": null, "DataCollectionLogoThumbnail": null, "DataCollectionLogoMediaType": "image/png", "RiskModelType": 0, "LowWeightedRiskScoreUpperLimit": 25, "StandardWeightedRiskScoreUpperLimit": 50, "HighWeightedRiskScoreUpperLimit": 75, "VeryHighWeightedRiskScoreUpperLimit": 100 "TermsAndConditionsEnabled": false, "TermsAndConditionsMessage": "", "LowRiskCriteriaName": "Person", "StandardRiskCriteriaName": "Person", "HighRiskCriteriaName": "Person High Risk", "VeryHighRiskCriteriaName": "Person High Risk", "EmailTemplateID": [56,59], "SnapshotType": 0 }] |
|
Action: | ADD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | POST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingtype/add | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Add a Static Onboarding Type and link to Client | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingTypeName | String | Onboarding type name | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingTypeDescription | String | Onboarding type description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LowRiskIDPalProfileType | Int 32 | ID-Pal profile identifier for low risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StandardRiskIDPalProfileType | Int 32 | ID-Pal profile identifier for standardrisk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | HighRiskIDPalProfileType | Int 32 | ID-Pal profile identifier for high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | VeryHighRiskIDPalProfileType | Int 32 | ID-Pal profile identifier for very high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LowRiskOnboardingApprovalType | Byte | Onboarding Approval Type for low risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StandardRiskOnboardingApprovalType | Byte | Onboarding Approval Type for standardrisk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | HighRiskOnboardingApprovalType | Byte | Onboarding Approval Type for high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | VeryHighRiskOnboardingApprovalType | Byte | Onboarding Approval Type for very high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LowRiskCriteriaID | Int 16 | Criteria Identifer for low risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StandardRiskCriteriaID | Int 16 | Criteria Identifer for standard risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | HighRiskCriteriaID | Int 16 | Criteria Identifer for high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | VeryHighRiskCriteriaID | Int 16 | Criteria Identifer for very high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LowRiskClientEntityRiskID | Int 16 | Risk Identifier for low risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StandardRiskClientEntityRiskID | Int 16 | Risk Identifier for standard risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | HighRiskClientEntityRiskID | Int 16 | Risk Identifier for high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | VeryHighRiskClientEntityRiskID | Int 16 | Risk Identifier for very high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DataCollectionWelcomeMessage | Int 16 | Welcome message to be send for data collection | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DataCollectionLogo | String | Base 64 string of the logo for the data requesting company | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DataCollectionLogoMediaType | String | Media type of the logo | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RiskModelType | Byte | Risk Model Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LowWeightedRiskScoreUpperLimit | Int 16 | Weighted Risk Score Upper Limit for Low Risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StandardWeightedRiskScoreUpperLimit | Int 16 | Weighted Risk Score Upper Limit for Standard Risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | HighWeightedRiskScoreUpperLimit | Int 16 | Weighted Risk Score Upper Limit for High Risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | VeryHighWeightedRiskScoreUpperLimit | Int 16 | Weighted Risk Score Upper Limit for Very High Risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TermsAndConditionsEnabled | Boolean | Terms And Conditions Enabled | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TermsAndConditionsMessage | Text 8000 | Terms And Conditions Message | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageDataCollection | Boolean | Exclude data collection stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageDataApproval | Boolean | Exclude data approval stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageIdentityVerification | Boolean | Exclude identity verification stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageIdentityApproval | Boolean | Exclude identity approval stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageScreening | Boolean | Exclude screening stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageComplianceApproval | Boolean | Exclude compliance approval stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | NomineeDataCollectionType | Byte | Nominee Data Collection Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | SnapshotType | Byte | Snapshot Type (0 = None, 1 = WithDocument, 2 = WithoutDocument, Optional default is 0) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Onboarding Type record added. { "OnboardingTypeID": 223, "OnboardingTypeName": "Trust", "OnboardingTypeDescription": "Trust", "LowRiskIDPalProfileType": 632, "StandardRiskIDPalProfileType": 632, "HighRiskIDPalProfileType": 632, "VeryHighRiskIDPalProfileType": 632, "LowRiskOnboardingApprovalType": 0, "StandardRiskOnboardingApprovalType": 0, "HighRiskOnboardingApprovalType": 0, "VeryHighRiskOnboardingApprovalType": 0, "LowRiskCriteriaID": 1, "StandardRiskCriteriaID": 40, "HighRiskCriteriaID": 39, "VeryHighRiskCriteriaID": 39, "LowRiskClientEntityRiskID": 1, "StandardRiskClientEntityRiskID": 2, "HighRiskClientEntityRiskID": 3, "VeryHighRiskClientEntityRiskID": 3, "ExcludeOnboardingStageDataCollection": false, "ExcludeOnboardingStageDataApproval": false, "ExcludeOnboardingStageIdentityVerification": false, "ExcludeOnboardingStageIdentityApproval": false, "ExcludeOnboardingStageScreening": false, "ExcludeOnboardingStageComplianceApproval": false, "NomineeDataCollectionType": 0, "DataCollectionWelcomeMessage": "Welcome to RiskScreen Onboard. Please complete this form and submit.", "DataCollectionLogo": null, "DataCollectionLogoThumbnail": null, "DataCollectionLogoMediaType": "", "RiskModelType": 0, "LowWeightedRiskScoreUpperLimit": 25, "StandardWeightedRiskScoreUpperLimit": 50, "HighWeightedRiskScoreUpperLimit": 75, "VeryHighWeightedRiskScoreUpperLimit": 100 "TermsAndConditionsEnabled": false, "TermsAndConditionsMessage": "", "LowRiskCriteriaName": "Person", "StandardRiskCriteriaName": "Person", "HighRiskCriteriaName": "Person High Risk", "VeryHighRiskCriteriaName": "Person High Risk", "SnapshotType": 0 } |
|
Action: | UPDATE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | PUT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingtype/update | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Update an existing Static Onboarding Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingTypeID | Int 32 | Onboarding type identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingTypeName | String | Onboarding type name | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingTypeDescription | String | Onboarding type description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LowRiskIDPalProfileType | Int 32 | ID-Pal profile identifier for low risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StandardRiskIDPalProfileType | Int 32 | ID-Pal profile identifier for standardrisk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | HighRiskIDPalProfileType | Int 32 | ID-Pal profile identifier for high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | VeryHighRiskIDPalProfileType | Int 32 | ID-Pal profile identifier for very high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LowRiskOnboardingApprovalType | Byte | Onboarding Approval Type for low risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StandardRiskOnboardingApprovalType | Byte | Onboarding Approval Type for standardrisk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | HighRiskOnboardingApprovalType | Byte | Onboarding Approval Type for high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | VeryHighRiskOnboardingApprovalType | Byte | Onboarding Approval Type for very high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LowRiskCriteriaID | Int 16 | Criteria Identifer for low risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StandardRiskCriteriaID | Int 16 | Criteria Identifer for standard risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | HighRiskCriteriaID | Int 16 | Criteria Identifer for high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | VeryHighRiskCriteriaID | Int 16 | Criteria Identifer for very high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LowRiskClientEntityRiskID | Int 16 | Risk Identifier for low risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StandardRiskClientEntityRiskID | Int 16 | Risk Identifier for standard risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | HighRiskClientEntityRiskID | Int 16 | Risk Identifier for high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | VeryHighRiskClientEntityRiskID | Int 16 | Risk Identifier for very high risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DataCollectionWelcomeMessage | Int 16 | Welcome message to be send for data collection | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DataCollectionLogo | String | Base 64 string of the logo for the data requesting company | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DataCollectionLogoMediaType | String | Media type of the logo | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RiskModelType | Byte | Risk Model Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LowWeightedRiskScoreUpperLimit | Int 16 | Weighted Risk Score Upper Limit for Low Risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StandardWeightedRiskScoreUpperLimit | Int 16 | Weighted Risk Score Upper Limit for Standard Risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | HighWeightedRiskScoreUpperLimit | Int 16 | Weighted Risk Score Upper Limit for High Risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | VeryHighWeightedRiskScoreUpperLimit | Int 16 | Weighted Risk Score Upper Limit for Very High Risk | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TermsAndConditionsEnabled | Boolean | Terms And Conditions Enabled | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TermsAndConditionsMessage | Text 8000 | Terms And Conditions Message | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageDataCollection | Boolean | Exclude data collection stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageDataApproval | Boolean | Exclude data approval stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageIdentityVerification | Boolean | Exclude identity verification stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageIdentityApproval | Boolean | Exclude identity approval stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageScreening | Boolean | Exclude screening stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeOnboardingStageComplianceApproval | Boolean | Exclude compliance approval stage? (True/False) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | NomineeDataCollectionType | Byte | Nominee Data Collection Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | SnapshotType | Byte | Snapshot Type (0 = None, 1 = WithDocument, 2 = WithoutDocument, Optional default is 0) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Onboarding Type record updated. { "OnboardingTypeID": 223, "OnboardingTypeName": "Trust", "OnboardingTypeDescription": "Trust", "LowRiskIDPalProfileType": 632, "StandardRiskIDPalProfileType": 632, "HighRiskIDPalProfileType": 632, "VeryHighRiskIDPalProfileType": 632, "LowRiskOnboardingApprovalType": 0, "StandardRiskOnboardingApprovalType": 0, "HighRiskOnboardingApprovalType": 0, "VeryHighRiskOnboardingApprovalType": 0, "LowRiskCriteriaID": 1, "StandardRiskCriteriaID": 40, "HighRiskCriteriaID": 39, "VeryHighRiskCriteriaID": 39, "LowRiskClientEntityRiskID": 1, "StandardRiskClientEntityRiskID": 2, "HighRiskClientEntityRiskID": 3, "VeryHighRiskClientEntityRiskID": 3, "ExcludeOnboardingStageDataCollection": false, "ExcludeOnboardingStageDataApproval": false, "ExcludeOnboardingStageIdentityVerification": false, "ExcludeOnboardingStageIdentityApproval": false, "ExcludeOnboardingStageScreening": false, "ExcludeOnboardingStageComplianceApproval": false, "NomineeDataCollectionType": 0, "DataCollectionWelcomeMessage": "Welcome to RiskScreen Onboard. Please complete this form and submit.", "DataCollectionLogo": null, "DataCollectionLogoThumbnail": null, "DataCollectionLogoMediaType": "", "RiskModelType": 0, "LowWeightedRiskScoreUpperLimit": 25, "StandardWeightedRiskScoreUpperLimit": 50, "HighWeightedRiskScoreUpperLimit": 75, "VeryHighWeightedRiskScoreUpperLimit": 100 "TermsAndConditionsEnabled": false, "TermsAndConditionsMessage": "", "LowRiskCriteriaName": "Person", "StandardRiskCriteriaName": "Person", "HighRiskCriteriaName": "Person High Risk", "VeryHighRiskCriteriaName": "Person High Risk", "SnapshotType": 0 } |
|
Action: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingtype/delete | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Delete an existing Static Onboarding Type link with Client and also the Static Onboarding Type if not linked to any other clients | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingTypeID | Int16 | Identifier of the Static Onboarding Type to delete | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Onboarding Type record deleted. { "OnboardingTypeID": 223, "OnboardingTypeName": "Trust", "OnboardingTypeDescription": "Trust", "LowRiskIDPalProfileType": 632, "StandardRiskIDPalProfileType": 632, "HighRiskIDPalProfileType": 632, "VeryHighRiskIDPalProfileType": 632, "LowRiskOnboardingApprovalType": 0, "StandardRiskOnboardingApprovalType": 0, "HighRiskOnboardingApprovalType": 0, "VeryHighRiskOnboardingApprovalType": 0, "LowRiskCriteriaID": 1, "StandardRiskCriteriaID": 40, "HighRiskCriteriaID": 39, "VeryHighRiskCriteriaID": 39, "LowRiskClientEntityRiskID": 1, "StandardRiskClientEntityRiskID": 2, "HighRiskClientEntityRiskID": 3, "VeryHighRiskClientEntityRiskID": 3, "ExcludeOnboardingStageDataCollection": false, "ExcludeOnboardingStageDataApproval": false, "ExcludeOnboardingStageIdentityVerification": false, "ExcludeOnboardingStageIdentityApproval": false, "ExcludeOnboardingStageScreening": false, "ExcludeOnboardingStageComplianceApproval": false, "NomineeDataCollectionType": 0, "DataCollectionWelcomeMessage": "Welcome to RiskScreen Onboard. Please complete this form and submit.", "DataCollectionLogo": null, "DataCollectionLogoThumbnail": null, "DataCollectionLogoMediaType": "", "RiskModelType": 0, "LowWeightedRiskScoreUpperLimit": 25, "StandardWeightedRiskScoreUpperLimit": 50, "HighWeightedRiskScoreUpperLimit": 75, "VeryHighWeightedRiskScoreUpperLimit": 100 "TermsAndConditionsEnabled": false, "TermsAndConditionsMessage": "", "LowRiskCriteriaName": "Person", "StandardRiskCriteriaName": "Person", "HighRiskCriteriaName": "Person High Risk", "VeryHighRiskCriteriaName": "Person High Risk", "SnapshotType": 0 } |
|