Action: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingtypepkyc/get | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch a Static Onboarding Type pKYC record based on Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | OnboardingTypeID | Int16 | OnboardingType Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | pKYCID | Int16 | Onboarding Type pKYC Rule Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Onboarding Type pKYC Rule record. { "OnboardingTypeID": 223, "pKYCID": 200, "pKYCName": "Person", "pKYCDesc": "Person Gibraltar", "TriggerTypeId": 1, "TriggerTypeDesc": "Risk", "TriggerDateOperator": 1, "TriggerDateOperatorDesc": "AfterDate", "TriggerDateMagnitude": 0, "TriggerDateTimespan": 1, "TriggerDateTimespanDesc": "Days", "TriggerValue": 1, "TriggerValueDesc": "Low", "TriggerAction": 3, "TriggerActionDesc": "Email Alert and Assign Onboarding Type", "TriggerOnboardingTypeID": 11, "TriggerOnboardingTypeIDDesc": "OB Type Name", "TriggerEmailTemplateID": 5, "TriggerEmailTemplateIDDesc": "Email temp Name", "TriggerEmailRecipientIDs": "1,2", "TriggerEmailRecipientDesc": "Handler,Supervisor", "TriggerCopyDCF": 1, "TriggerCopyDCFDesc": "Yes", "TriggerStatus": 1, "TriggerStatusDesc": "Active" } |
|
Action: | GET ALL | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingtypepkyc/GetAll | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch all Static Onboarding Type pKYC record based on Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | OnboardingTypeID | Int16 | OnboardingType Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML collection of Static Onboarding Type pKYC Rule records. [{ "OnboardingTypeID": 223, "pKYCID": 200, "pKYCName": "Person", "pKYCDesc": "Person Gibraltar", "TriggerTypeId": 1, "TriggerTypeDesc": "Risk", "TriggerDateOperator": 1, "TriggerDateOperatorDesc": "AfterDate", "TriggerDateMagnitude": 0, "TriggerDateTimespan": 1, "TriggerDateTimespanDesc": "Days", "TriggerValue": 1, "TriggerValueDesc": "Low", "TriggerAction": 3, "TriggerActionDesc": "Email Alert and Assign Onboarding Type", "TriggerOnboardingTypeID": 11, "TriggerOnboardingTypeIDDesc": "OB Type Name", "TriggerEmailTemplateID": 5, "TriggerEmailTemplateIDDesc": "Email temp Name", "TriggerEmailRecipientIDs": "1,2", "TriggerEmailRecipientDesc": "Handler,Supervisor", "TriggerCopyDCF": 1, "TriggerCopyDCFDesc": "Yes", "TriggerStatus": 1, "TriggerStatusDesc": "Active" }] |
|
Action: | ADD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | POST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingtypepkyc/add | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Add a Static Onboarding Type pKYC Rule | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | pKYCName | String | pKYC Rule Name | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | pKYCDesc | String | pKYC Rule description | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerTypeID | Byte | Trigger Type ID (1 = Risk, 2 = Property, 3 = Identity Approval, 4 = Onboarded Date) | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerValue | Int 32 | Trigger Value Options When TriggerTypeID = 1, then 1 = Low, 2 = Standard, 3 = High, 4 = Very High When TriggerTypeID = 2, then OnboardingPropertyID (linked to configuration OnboardingTypeID) When TriggerTypeId = 3, then 1 = Passport Expiry, 2 = ID expiry When TriggerTypeId = 4, then 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerActionID | Byte | Trigger Action ID (defaults to 0 , 1 = Email Alert, 2 = Email Alert and Assign Onboarding Type, 3 = Email Alert and Start Onboarding Type, 4 = Assign Onboarding Type, 5 = Start Onboarding Type) | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerEmailRecipientTypeIDs | Text [200] | Trigger Email Recepient IDs comma separated (defaults to 0, 1 = Handler, 2 = Supervisor, 3 = Manager, 4 = Director); optional but necessary if TriggerActionID = 1 or 2 or 3 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerOnboardingTypeID | Int32 | Trigger Onboarding Type ID (defaults to 0); optional but necessary if TriggerActionID != 0 and 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerEmailTemplateID | Int32 | Trigger Email Template ID (defaults to 0); optional but necessary if TriggerActionID = 3 or 5 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerDateOperator | Byte | Trigger Date Operator (defaults to 0, 1 = After Date, 2 = Before Date); optional but necessary if TriggerActionID != 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerDateMagnitude | Int32 | Trigger Date Magnitude (defaults to 0); optional but necessary if TriggerActionID != 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerDateTimespan | Byte | Trigger Date Timespan (defaults to 0, 1 = Days, 2 = Weeks, 3 = Months, 4 = Quarters, 5 = Years, 6 = Decades); optional but necessary if TriggerActionID != 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerCopyDCF | Boolean | Trigger Copy DCF (defaults to 0 = No, 1 = Yes); optional; nevertheless, it can only be set to 1 if TriggerOnboardingTypeID and configuration OnboardingTypeID are the same | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerStatus | Byte | Optional parameter - Trigger Status (enable only when Updating existing pKYC, default is 1. 0 = Inactive, 1 = Active) | |||||||||||||||||||||||||||||||||||||||||||||||||||||
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 pKYC Rule record added. { "OnboardingTypeID": 223, "pKYCID": 200, "pKYCName": "Person", "pKYCDesc": "Person Gibraltar", "TriggerTypeId": 1, "TriggerTypeDesc": "Risk", "TriggerDateOperator": 1, "TriggerDateOperatorDesc": "AfterDate", "TriggerDateMagnitude": 0, "TriggerDateTimespan": 1, "TriggerDateTimespanDesc": "Days", "TriggerValue": 1, "TriggerValueDesc": "Low", "TriggerAction": 3, "TriggerActionDesc": "Email Alert and Assign Onboarding Type", "TriggerOnboardingTypeID": 11, "TriggerOnboardingTypeIDDesc": "OB Type Name", "TriggerEmailTemplateID": 5, "TriggerEmailTemplateIDDesc": "Email temp Name", "TriggerEmailRecipientIDs": "1,2", "TriggerEmailRecipientDesc": "Handler,Supervisor", "TriggerCopyDCF": 1, "TriggerCopyDCFDesc": "Yes", "TriggerStatus": 1, "TriggerStatusDesc": "Active" } |
|
Action: | UPDATE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | PUT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingtypepkyc/update | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Update an existing Static Onboarding Type pKYC Rule | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | pKYCID | Int 32 | Onboarding Type pKYC Rule Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | pKYCName | String | pKYC Rule Name | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | pKYCDesc | String | pKYC Rule description | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerTypeID | Byte | Trigger Type ID (1 = Risk, 2 = Property, 3 = Identity Approval, 4 = Onboarded Date) | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerValue | Int 32 | Trigger Value Options When TriggerTypeID = 1, then 1 = Low, 2 = Standard, 3 = High, 4 = Very High When TriggerTypeID = 2, then OnboardingPropertyID (linked to configuration OnboardingTypeID) When TriggerTypeId = 3, then 1 = Passport Expiry, 2 = ID expiry When TriggerTypeId = 4, then 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerActionID | Byte | Trigger Action ID (defaults to 0 , 1 = Email Alert, 2 = Email Alert and Assign Onboarding Type, 3 = Email Alert and Start Onboarding Type, 4 = Assign Onboarding Type, 5 = Start Onboarding Type) | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerEmailRecipientTypeIDs | Text [200] | Trigger Email Recepient IDs comma separated (defaults to 0, 1 = Handler, 2 = Supervisor, 3 = Manager, 4 = Director); optional but necessary if TriggerActionID = 1 or 2 or 3 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerOnboardingTypeID | Int32 | Trigger Onboarding Type ID (defaults to 0); optional but necessary if TriggerActionID != 0 and 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerEmailTemplateID | Int32 | Trigger Email Template ID (defaults to 0); optional but necessary if TriggerActionID = 3 or 5 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerDateOperator | Byte | Trigger Date Operator (defaults to 0, 1 = After Date, 2 = Before Date); optional but necessary if TriggerActionID != 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerDateMagnitude | Int32 | Trigger Date Magnitude (defaults to 0); optional but necessary if TriggerActionID != 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerDateTimespan | Byte | Trigger Date Timespan (defaults to 0, 1 = Days, 2 = Weeks, 3 = Months, 4 = Quarters, 5 = Years, 6 = Decades); optional but necessary if TriggerActionID != 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerCopyDCF | Boolean | Trigger Copy DCF (defaults to 0 = No, 1 = Yes); optional; nevertheless, it can only be set to 1 if TriggerOnboardingTypeID and configuration OnboardingTypeID are the same | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | TriggerStatus | Byte | Optional parameter - Trigger Status (enable only when Updating existing pKYC, default is 1. 0 = Inactive, 1 = Active) | |||||||||||||||||||||||||||||||||||||||||||||||||||||
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 pKYC Rule record updated. { "OnboardingTypeID": 223, "pKYCID": 200, "pKYCName": "Person", "pKYCDesc": "Person Gibraltar", "TriggerTypeId": 1, "TriggerTypeDesc": "Risk", "TriggerDateOperator": 1, "TriggerDateOperatorDesc": "AfterDate", "TriggerDateMagnitude": 0, "TriggerDateTimespan": 1, "TriggerDateTimespanDesc": "Days", "TriggerValue": 1, "TriggerValueDesc": "Low", "TriggerAction": 3, "TriggerActionDesc": "Email Alert and Assign Onboarding Type", "TriggerOnboardingTypeID": 11, "TriggerOnboardingTypeIDDesc": "OB Type Name", "TriggerEmailTemplateID": 5, "TriggerEmailTemplateIDDesc": "Email temp Name", "TriggerEmailRecipientIDs": "1,2", "TriggerEmailRecipientDesc": "Handler,Supervisor", "TriggerCopyDCF": 1, "TriggerCopyDCFDesc": "Yes", "TriggerStatus": 1, "TriggerStatusDesc": "Active" } |
|
Action: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/onboardingtypepkyc/delete | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Delete an existing Static Onboarding Type pKYC Rule | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | pKYCID | Int16 | Onboarding Type pKYC Rule 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 Type pKYC Rule record deleted. { "OnboardingTypeID": 223, "pKYCID": 200, "pKYCName": "Person", "pKYCDesc": "Person Gibraltar", "TriggerTypeId": 1, "TriggerTypeDesc": "Risk", "TriggerDateOperator": 1, "TriggerDateOperatorDesc": "AfterDate", "TriggerDateMagnitude": 0, "TriggerDateTimespan": 1, "TriggerDateTimespanDesc": "Days", "TriggerValue": 1, "TriggerValueDesc": "Low", "TriggerAction": 3, "TriggerActionDesc": "Email Alert and Assign Onboarding Type", "TriggerOnboardingTypeID": 11, "TriggerOnboardingTypeIDDesc": "OB Type Name", "TriggerEmailTemplateID": 5, "TriggerEmailTemplateIDDesc": "Email temp Name", "TriggerEmailRecipientIDs": "1,2", "TriggerEmailRecipientDesc": "Handler,Supervisor", "TriggerCopyDCF": 1, "TriggerCopyDCFDesc": "Yes", "TriggerStatus": 1, "TriggerStatusDesc": "Active" } |
|