Action: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingstructure/get | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch a Static Onboarding Structure record based on Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | OnboardingTypeID | Int32 | Onboarding Type Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | OnboardingPropertyGroupID | Int32 | Onboarding Property Group Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | OnboardingPropertyID | Int32 | Onboarding Property Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Onboarding Structure record. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52000, "OnboardingPropertyID": 51000, "OnboardingTypeName": "Person", "OnboardingTypeDescription": "Person", "OnboardingPropertyGroupName": "Name", "OnboardingPropertyGroupDescription": "Name", "OnboardingPropertyName": "Last Name", "OnboardingPropertyDescription": "Last Name", "PropertyOrder": 1, "RequiredField": true, "StoreID": 1, "ScreeningID": 0, "DefaultListDataID": 0, "TextDefaultValue": "", "IntegerDefaultValue": null, "DecimalDefaultValue": null, "RiskDefaultValue": 0, "WeightedRiskDefaultValue": 0, "RiskWeightPercent": 100, "RiskFactorOverride": false, "RiskFactorOverrideValue": 0, "ListFilterOption": 0, "ListGroupID": 0, "ListGroupName": "", "TextMinimumSize": 2, "TextMaximumSize": 50, "IntegerMinimumValue": null, "IntegerMaximumValue": null, "DecimalMinimumValue": null, "DecimalMaximumValue": null, "DecimalDigits": 2, "DecimalSymbol": "", "DateMinimumValue": null, "DateMaximumValue": null, "EnabledForRisk": false, "KYBPropertyTypeID": 0, "ReferrenceID": "" } |
|
Action: | GET ALL | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingstructure/getall | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch all Static Onboarding Structure records of a Property Group for an Onboarding Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | OnboardingTypeID | Int32 | Onboarding Type Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | OnboardingPropertyGroupID | Int32 | Onboarding Property Group Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML collection of Static Onboarding Structure records. [{ "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52000, "OnboardingPropertyID": 51000, "OnboardingTypeName": "Person", "OnboardingTypeDescription": "Person", "OnboardingPropertyGroupName": "Name", "OnboardingPropertyGroupDescription": "Name", "OnboardingPropertyName": "Last Name", "OnboardingPropertyDescription": "Last Name", "PropertyOrder": 1, "RequiredField": true, "StoreID": 1, "ScreeningID": 0, "DefaultListDataID": 0, "TextDefaultValue": "", "IntegerDefaultValue": null, "DecimalDefaultValue": null, "RiskDefaultValue": 0, "WeightedRiskDefaultValue": 0, "RiskWeightPercent": 100, "RiskFactorOverride": false, "RiskFactorOverrideValue": 0, "ListFilterOption": 0, "ListGroupID": 0, "ListGroupName": "", "TextMinimumSize": 2, "TextMaximumSize": 50, "IntegerMinimumValue": null, "IntegerMaximumValue": null, "DecimalMinimumValue": null, "DecimalMaximumValue": null, "DecimalDigits": 2, "DecimalSymbol": "", "DateMinimumValue": null, "DateMaximumValue": null, "EnabledForRisk": false, "KYBPropertyTypeID": 0, "ReferrenceID": "" }] |
|
Action: | ADD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | POST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingstructure/add | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Add a Static Onboarding Structure record | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | OnboardingPropertyGroupID | Int 32 | Onboarding Property Group Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingPropertyName | Text 300 | Onboarding Property Group Name | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingPropertyDescription | Text 600 | Onboarding Property Group Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | PropertyOrder | Int 32 | Property Order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Hidden | Boolean | Is the property hidden? (True = Yes, False = No) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Responsive | Byte | Is the property responsive? (0 = No, 1 = Yes Show Initially, 2 = Yes Hide Initially) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RequiredField | Boolean | Is the property mandatory? (True = Yes, False = No) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ListDefaultListDataID | Int 32 | Default List Data Identifier or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TextDefaultValue | Text 500 | Default text value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IntegerDefaultValue | Int 32 | Default integer value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DecimalDefaultValue | Decimal | Default decimal value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RiskDefaultValue | Byte | Risk Default Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | WeightedRiskDefaultValue | Byte | Weighted Risk Default Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RiskWeightPercent | Byte | Risk Weight Percent | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RiskFactorOverride | Boolean | Risk Factor Override | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RiskFactorOverrideValue | Byte | Risk Factor Override Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ListFilterOption | Byte | List Filter Option(0 = None, 1 = Risk Rule) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StoreID | Byte | Static Store Identifer(100 = Text, 101 = Integer, 102 = Decimal, 103 = Date, 104 = List) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ScreeningID | Byte | Static Screening Type Identifier(1 = Screening DOB, 2 = Screening Country 1, 3 = Screening Country 2, 4 = Screening Country 3, 5 = Screening Gender) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ListGroupID | Int 32 | List Group Identifier or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TextMinimumSize | Int 32 | Text minimum length | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TextMaximumSize | Int 32 | Text maximum length | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IntegerMinimumValue | Int 32 | Minimum acceptable integer value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IntegerMaximumValue | Int 32 | Maximum acceptable integer value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DecimalMinimumValue | Decimal | Minimum acceptable decimal value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DecimalMaximumValue | Decimal | Maximum acceptable integer value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DecimalDigits | Byte | Number of digits after the decimal | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DateMinimumValue | Date | Minimum acceptable date value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DateMaximumValue | Date | Maximum acceptable date value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | EnabledForRisk | Boolean | Is the property enabled for risk calculation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | KYBPropertyTypeID | Byte | KYB Property Type Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DecimalSymbol | Text 10 | Decimal Symbol | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Onboarding Structure record added. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52000, "OnboardingPropertyID": 51104, "OnboardingTypeName": "Person", "OnboardingTypeDescription": "Person", "OnboardingPropertyGroupName": "Name", "OnboardingPropertyGroupDescription": "Name", "OnboardingPropertyName": "Maiden Name", "OnboardingPropertyDescription": "Maiden Name", "PropertyOrder": 4, "RequiredField": false, "StoreID": 1, "ScreeningID": 0, "DefaultListDataID": null, "TextDefaultValue": "", "IntegerDefaultValue": null, "DecimalDefaultValue": null, "RiskDefaultValue": null, "WeightedRiskDefaultValue": 0, "RiskWeightPercent": 100, "RiskFactorOverride": false, "RiskFactorOverrideValue": 0, "ListFilterOption": 0, "ListGroupID": null, "ListGroupName": "", "TextMinimumSize": 0, "TextMaximumSize": 50, "IntegerMinimumValue": null, "IntegerMaximumValue": null, "DecimalMinimumValue": null, "DecimalMaximumValue": null, "DecimalDigits": 2, "DecimalSymbol": "", "DateMinimumValue": null, "DateMaximumValue": null, "EnabledForRisk": false, "KYBPropertyTypeID": 0, "Hidden": false, "Responsive": 1, "ReferrenceID": "" } |
|
Action: | UPDATE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | PUT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingstructure/update | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Update an existing Static Onboarding Structure | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | OnboardingPropertyGroupID | Int 32 | Onboarding Property Group Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingPropertyName | Text 300 | Onboarding Property Group Name | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingPropertyDescription | Text 600 | Onboarding Property Group Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | PropertyOrder | Int 32 | Property Order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Hidden | Boolean | Is the property hidden? (True = Yes, False = No) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Responsive | Byte | Is the property responsive? (0 = No, 1 = Yes Show Initially, 2 = Yes Hide Initially) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RequiredField | Boolean | Is the property mandatory? (True = Yes, False = No) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ListDefaultListDataID | Int 32 | Default List Data Identifier or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TextDefaultValue | Text 500 | Default text value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IntegerDefaultValue | Int 32 | Default integer value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DecimalDefaultValue | Decimal | Default decimal value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RiskDefaultValue | Byte | Risk Default Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | WeightedRiskDefaultValue | Byte | Weighted Risk Default Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RiskWeightPercent | Byte | Risk Weight Percent | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RiskFactorOverride | Boolean | Risk Factor Override | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | RiskFactorOverrideValue | Byte | Risk Factor Override Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ListFilterOption | Byte | List Filter Option(0 = None, 1 = Risk Rule) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | StoreID | Byte | Static Store Identifer(100 = Text, 101 = Integer, 102 = Decimal, 103 = Date, 104 = List) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ScreeningID | Byte | Static Screening Type Identifier(1 = Screening DOB, 2 = Screening Country 1, 3 = Screening Country 2, 4 = Screening Country 3, 5 = Screening Gender) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ListGroupID | Int 32 | List Group Identifier or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TextMinimumSize | Int 32 | Text minimum length | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TextMaximumSize | Int 32 | Text maximum length | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IntegerMinimumValue | Int 32 | Minimum acceptable integer value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IntegerMaximumValue | Int 32 | Maximum acceptable integer value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DecimalMinimumValue | Decimal | Minimum acceptable decimal value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DecimalMaximumValue | Decimal | Maximum acceptable integer value or blank | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DecimalDigits | Byte | Number of digits after the decimal | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DateMinimumValue | Date | Minimum acceptable date value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DateMaximumValue | Date | Maximum acceptable date value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | EnabledForRisk | Boolean | Is the property enabled for risk calculation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | KYBPropertyTypeID | Byte | KYB Property Type Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | DecimalSymbol | Text 10 | Decimal Symbol | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Onboarding Structure record updated. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52000, "OnboardingPropertyID": 51104, "OnboardingTypeName": "Person", "OnboardingTypeDescription": "Person", "OnboardingPropertyGroupName": "Name", "OnboardingPropertyGroupDescription": "Name", "OnboardingPropertyName": "Maiden Name", "OnboardingPropertyDescription": "Maiden Name", "PropertyOrder": 4, "RequiredField": false, "StoreID": 1, "ScreeningID": 0, "DefaultListDataID": null, "TextDefaultValue": "", "IntegerDefaultValue": null, "DecimalDefaultValue": null, "RiskDefaultValue": null, "WeightedRiskDefaultValue": 0, "RiskWeightPercent": 100, "RiskFactorOverride": false, "RiskFactorOverrideValue": 0, "ListFilterOption": 0, "ListGroupID": null, "ListGroupName": "", "TextMinimumSize": 0, "TextMaximumSize": 50, "IntegerMinimumValue": null, "IntegerMaximumValue": null, "DecimalMinimumValue": null, "DecimalMaximumValue": null, "DecimalDigits": 2, "DecimalSymbol": "", "DateMinimumValue": null, "DateMaximumValue": null, "EnabledForRisk": false, "KYBPropertyTypeID": 0, "Hidden": false, "Responsive": 1, "ReferrenceID": "" } |
|
Action: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingstructure/delete | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Delete an existing Static Onboarding Structure record | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingTypeID | Int32 | Onboarding Type Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingPropertyGroupID | Int32 | Onboarding Property Group Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | OnboardingPropertyID | Int32 | Onboarding Property Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Onboarding Structure record deleted. { "OnboardingTypeID": 200, "OnboardingPropertyGroupID": 52000, "OnboardingPropertyID": 51104, "OnboardingTypeName": "Person", "OnboardingTypeDescription": "Person", "OnboardingPropertyGroupName": "Name", "OnboardingPropertyGroupDescription": "Name", "OnboardingPropertyName": "Maiden Name", "OnboardingPropertyDescription": "Maiden Name", "PropertyOrder": 4, "RequiredField": false, "StoreID": 1, "ScreeningID": 0, "DefaultListDataID": null, "TextDefaultValue": "", "IntegerDefaultValue": null, "DecimalDefaultValue": null, "RiskDefaultValue": null, "WeightedRiskDefaultValue": 0, "RiskWeightPercent": 100, "RiskFactorOverride": false, "RiskFactorOverrideValue": 0, "ListFilterOption": 0, "ListGroupID": null, "ListGroupName": "", "TextMinimumSize": 0, "TextMaximumSize": 50, "IntegerMinimumValue": null, "IntegerMaximumValue": null, "DecimalMinimumValue": null, "DecimalMaximumValue": null, "DecimalDigits": 2, "DecimalSymbol": "", "DateMinimumValue": null, "DateMaximumValue": null, "EnabledForRisk": false, "KYBPropertyTypeID": 0, "Hidden": false, "Responsive": 1, "ReferrenceID": "" } |
|
Action: | EXPORT | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingstructure/export | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Static Onboarding Structure Export | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | BusinessUnitID | Int32 | Business Unit Identifier (optional - value defaulted to 10 if not provided) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | OnboardingTypeIDs | String | Commas Separated Static Onboarding Type Identifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ActionUserID | Int16 | Identifier of the User performing action. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Onboarding Structure Export { "ProspectOnboardingData": { "ClientProspectID": , "ClientOnboardingID": , "ProspectRef": "ABC123", "ClientEntityRef": "ABC123-DEF456", "FirstName": "John", "LastName": "Smith", "MiddleName": "Edward", "Email": "test@riskscreen.com", "MobilePhone": "7787654321", "OnboardingTypeID": 200, "ProspectStatus": 1, "DateAdded": "", "HandledByGroupID": 204, "HandledByUserID": 103, "OnboardingStageID": 1, "RiskModelType": 1, "ReferrenceIDs":[ "R1", "R2" ] }, "ProspectRelationshipData": { "ClientProspectGroupID": 1, "ClientProspectInterfaceReference": "ABC123XWSRE", "ProspectRelationshipID": 1 "ParentProspectInterfaceReference": "DEF456ART" "UBOOwnershipPercentage": 0, "DirectOwnershipPercentage": 0, "Value1": 1.123456789, "Value2": 0, "Value3": 0, "Value4": 0, "Value5": 0, "Value6": 0, "Value7": 0, "UseLeadProspectEmailAddress": 0, "ProspectEmailAddress": "abc@riskscreen.com" }, "MappingTable": [ { "ReferenceID": "R1", "OnboardingTypeID": 203, "OnboardingTypeName": "Test", "OnboardingPropertyGroupID": 52005, "OnboardingPropertyGroupName": "Personal Detail", "OnboardingPropertyID": 51023, "OnboardingPropertyName": "Gender", "StoreID": 5, "RequiredField": "TRUE", "ListGroupID": 33003, "DefaultListDataID": 0, "TextMinimumSize": 0, "TextMaximumSize": 0, "TextDefaultValue": "", "IntegerMinimumValue": NULL, "IntegerMaximumValue": NULL, "IntegerDefaultValue": NULL, "DecimalMinimumValue": 0, "DecimalMaximumValue": 0, "DecimalDigits": 2, "DecimalDefaultValue": NULL, "DateMinimumValue": NULL, "DateMaximumValue": NULL } ], "ListExtract": [ { "ListGroupID": 33003, "ListGroupName": "Gender", "ListDataID": 34510, "ListDataName": "Female" } ], "ProspectGroupExtract": [ { "BusinessUnitID": 10, "ClientProspectGroupID": 1, "Name": "De Lima and Pedro", "Description": "The De Lima and Pedro Application" } ], "ProspectRelationshipExtract": [ { "ProspectRelationshipID": 1, "Name": "Director", "Description": "Director", "Value1Name": "", "Value2Name": "", "Value3Name": "", "Value4Name": "", "Value5Name": "", "Value6Name": "", "Value7Name": "", "Value1Decimals": 0, "Value2Decimals": 0, "Value3Decimals": 0, "Value4Decimals": 0, "Value5Decimals": 0, "Value6Decimals": 0, "Value7Decimals": 0, "Value1Enabled": false, "Value2Enabled": false, "Value3Enabled": false, "Value4Enabled": false, "Value5Enabled": false, "Value6Enabled": false, "Value7Enabled": false } ] } |
|