| 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 } |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 }] |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||