Tuesday, July 16, 2024

Static - Onboarding Stage
Action:
GET
Method:
GET
URL: /api/v1/static/onboardingstage/get
Description: Fetch a Static Onboarding Stage record based on Identifier
Type Key DataType Notes
Headers api-key String Your Api-Key
Params OnboardingTypeID Int32 Onboarding Type Identifier
Params OnboardingStageID Int32 Onboarding Stage Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Onboarding Stage record.
{
 "OnboardingTypeID": 200,
 "OnboardingStageID": 1,
 "Name": "Data Collection",
 "Description": "Data Collection",
 "Active": true,
 "AutoApproveLowRisk": false,
 "AutoApproveStandardRisk": false,
 "AutoApproveHighRisk": false,
 "AutoApproveFaceMatch": false,
 "AutoApproveDataAuth": false,
 "AutoApproveAddrVerfResult": false
 "SendIDPalLinkOnOnboardingDataSubmission": false
 "NomineeDataCollectionType": 0,
 "IDPalLinkSentConfirmationMessage": ""
 "ExternalProspectAutosendEmailTemplateID": 0,
 "ExternalProspectAutosendEmailMessage": "",
 "KYBPersonProspectEmailTemplateID": 0,
 "KYBPersonProspectEmailMessage": "",
 "KYBCorporateProspectEmailTemplateID": 0,
 "KYBCorporateProspectEmailMessage": "",
 "IDPalEmailSubject": "",
 "IDPalEmailBody": "",
 "EmailAlertDisabled": false,
 "EmailAlertToAllHandlers": 0,
 "EmailAlertToAllSupervisors": 0,
 "EmailAlertToAllManagers": 0,
 "EmailAlertToAllDirectors": 0,
 "LeadProspectApprovalType": 0,
 "KYBPersonProspectOnboardingTypeID": 0,
 "KYBPersonProspectEmailTemplateID": 0,
 "KYBPersonProspectEmailMessage": "",
 "KYBCorporateProspectOnboardingTypeID": 0,
 "KYBCorporateProspectEmailTemplateID": 0,
 "KYBCorporateProspectEmailMessage": "",
 "KYBProspectHandledByUserGroupID": 0,
 "KYBProspectHandledByUserID": 0,
 "KYBProspectAction": 0,
 "KYBEmailAlertDisabled": false
}
Field Data Type
OnboardingTypeID Int 32
OnboardingStageID Int 32
Name Text 100
Description Text 200
Active Boolean
AutoApproveLowRisk Boolean
AutoApproveStandardRisk Boolean
AutoApproveHighRisk Boolean
AutoApproveFaceMatch Boolean
AutoApproveDataAuth Boolean
AutoApproveAddrVerfResult Boolean
SendIDPalLinkOnOnboardingDataSubmission Boolean
NomineeDataCollectionType byte
IDPalLinkSentConfirmationMessage Text 4000
ExternalProspectAutosendEmailTemplateID Int 32
ExternalProspectAutosendEmailMessage Text 4000
KYBPersonProspectEmailTemplateID Int 32
KYBPersonProspectEmailMessage Text 4000
KYBCorporateProspectEmailTemplateID Int 32
KYBCorporateProspectEmailMessage Text 4000
IDPalEmailSubject Text 50
IDPalEmailBody Text 4000
EmailAlertDisabled Boolean
EmailAlertToAllHandlers Int 32
EmailAlertToAllSupervisors Int 32
EmailAlertToAllManagers Int 32
EmailAlertToAllDirectors Int 32
LeadProspectApprovalType Byte
KYBPersonProspectOnboardingTypeID Int 32
KYBPersonProspectEmailTemplateID Int 32
KYBPersonProspectEmailMessage Text 4000
KYBCorporateProspectOnboardingTypeID Int 32
KYBCorporateProspectEmailTemplateID Int 32
KYBCorporateProspectEmailMessage Text 4000
KYBProspectHandledByUserGroupID Int 32
KYBProspectHandledByUserID Int 32
KYBProspectAction Int 32
KYBEmailAlertDisabled Boolean
Action:
GET ALL
Method:
GET
URL: /api/v1/static/onboardingstage/getall
Description: Fetch all Static Onboarding Stage records linked to an Onboarding Type
Type Key DataType Notes
Headers api-key String Your Api-Key
Params OnboardingTypeID Int32 Onboarding Type Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Static Onboarding Stage records.
[{
 "OnboardingTypeID": 200,
 "OnboardingStageID": 1,
 "Name": "Data Collection",
 "Description": "Data Collection",
 "Active": true,
 "AutoApproveLowRisk": false,
 "AutoApproveStandardRisk": false,
 "AutoApproveHighRisk": false,
 "AutoApproveFaceMatch": false,
 "AutoApproveDataAuth": false,
 "AutoApproveAddrVerfResult": false
 "SendIDPalLinkOnOnboardingDataSubmission": false
 "NomineeDataCollectionType": 0,
 "IDPalLinkSentConfirmationMessage": ""
 "ExternalProspectAutosendEmailTemplateID": 0,
 "ExternalProspectAutosendEmailMessage": "",
 "KYBPersonProspectEmailTemplateID": 0,
 "KYBPersonProspectEmailMessage": "",
 "IDPalEmailSubject": "",
 "IDPalEmailBody": "",
 "EmailAlertDisabled": false,
 "EmailAlertToAllHandlers": 0,
 "EmailAlertToAllSupervisors": 0,
 "EmailAlertToAllManagers": 0,
 "EmailAlertToAllDirectors": 0,
 "LeadProspectApprovalType": 0,
 "KYBPersonProspectOnboardingTypeID": 0,
 "KYBPersonProspectEmailTemplateID": 0,
 "KYBPersonProspectEmailMessage": "",
 "KYBCorporateProspectOnboardingTypeID": 0,
 "KYBCorporateProspectEmailTemplateID": 0,
 "KYBCorporateProspectEmailMessage": "",
 "KYBProspectHandledByUserGroupID": 0,
 "KYBProspectHandledByUserID": 0,
 "KYBProspectAction": 0,
 "KYBEmailAlertDisabled": false
}]
Field Data Type
OnboardingTypeID Int 32
OnboardingStageID Int 32
Name Text 100
Description Text 200
Active Boolean
AutoApproveLowRisk Boolean
AutoApproveStandardRisk Boolean
AutoApproveHighRisk Boolean
AutoApproveFaceMatch Boolean
AutoApproveDataAuth Boolean
AutoApproveAddrVerfResult Boolean
SendIDPalLinkOnOnboardingDataSubmission Boolean
NomineeDataCollectionType byte
IDPalLinkSentConfirmationMessage Text 4000
ExternalProspectAutosendEmailTemplateID Int 32
ExternalProspectAutosendEmailMessage Text 4000
KYBPersonProspectEmailTemplateID Int 32
KYBPersonProspectEmailMessage Text 4000
KYBCorporateProspectEmailTemplateID Int 32
KYBCorporateProspectEmailMessage Text 4000
IDPalEmailSubject Text 50
IDPalEmailBody Text 4000
EmailAlertDisabled Boolean
EmailAlertToAllHandlers Int 32
EmailAlertToAllSupervisors Int 32
EmailAlertToAllManagers Int 32
EmailAlertToAllDirectors Int 32
LeadProspectApprovalType Byte
KYBPersonProspectOnboardingTypeID Int 32
KYBPersonProspectEmailTemplateID Int 32
KYBPersonProspectEmailMessage Text 4000
KYBCorporateProspectOnboardingTypeID Int 32
KYBCorporateProspectEmailTemplateID Int 32
KYBCorporateProspectEmailMessage Text 4000
KYBProspectHandledByUserGroupID Int 32
KYBProspectHandledByUserID Int 32
KYBProspectAction Int 32
KYBEmailAlertDisabled Boolean