Tuesday, July 16, 2024

Static - Onboarding Data Document Type
Action:
GET
Method:
GET
URL: /api/v1/static/onboardingdatadocumenttype/get
Description: Fetch a Static Onboarding Data Document Type record based on Identifier
Type Key DataType Notes
Headers api-key String Your Api-Key
Params OnboardingTypeID Int32 Onboarding Type Identifier
Params OnboardingDataDocumentTypeID Int32 Onboarding Data Document Type Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Onboarding Data Document Type record.
{
 "OnboardingTypeID": 211,
 "OnboardingDataDocumentTypeID": 3,
 "Name": "Passport",
 "Description": "Passport",
 "Mandatory": false
}
Field Data Type
OnboardingTypeID Int 32
OnboardingDataDocumentTypeID Int 32
Name Text 300
Description Text 500
Mandatory Boolean
Action:
GET ALL
Method:
GET
URL: /api/v1/static/onboardingdatadocumenttype/getall
Description: Fetch all Static Onboarding Data Document Type 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 Data Document Type records.
[{
 "OnboardingTypeID": 211,
 "OnboardingDataDocumentTypeID": 3,
 "Name": "Passport",
 "Description": "Passport",
 "Mandatory": false
}]
Field Data Type
OnboardingTypeID Int 32
OnboardingDataDocumentTypeID Int 32
Name Text 300
Description Text 500
Mandatory Boolean
Action:
ADD
Method:
POST
URL: /api/v1/static/onboardingdatadocumenttype/add
Description: Add a Static Onboarding Data Document Type and link it to an 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 Int32 Onboarding Type Identifier
Body Name String Name
Body Description String Description
Body Mandatory Boolean Is the document type mandatory? (True = Yes, Default value false if left blank)
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Onboarding Data Document Type record added.
{
 "OnboardingTypeID": 211,
 "OnboardingDataDocumentTypeID": 7,
 "Name": "Driving License",
 "Description": "Driving License",
 "Mandatory": true
}
Field Data Type
OnboardingTypeID Int 32
OnboardingDataDocumentTypeID Int 32
Name Text 300
Description Text 500
Mandatory Boolean
Action:
UPDATE
Method:
PUT
URL: /api/v1/static/onboardingdatadocumenttype/update
Description: Update an existing Static Onboarding Data Document Type record linked to an 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 Int32 Onboarding Type Identifier
Body OnboardingDataDocumentTypeID Int32 Onboarding Data Document Type Identifier
Body Name String Name
Body Description String Description
Body Mandatory Boolean Is the document type mandatory? (True = Yes, Default value false if left blank)
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Onboarding Data Document Type record updated.
{
 "OnboardingTypeID": 211,
 "OnboardingDataDocumentTypeID": 7,
 "Name": "Driving License",
 "Description": "Driving License",
 "Mandatory": true
}
Field Data Type
OnboardingTypeID Int 32
OnboardingDataDocumentTypeID Int 32
Name Text 300
Description Text 500
Mandatory Boolean
Action:
DELETE
Method:
DELETE
URL: /api/v1/static/onboardingdatadocumenttype/delete
Description: Delete an existing Static Onboarding Data Document Type linked with Onboarding Type Identifer
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 OnboardingDataDocumentTypeID Int16 Identifier of the Static Onboarding Data Document 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 Data Document Type record deleted.
{
 "OnboardingTypeID": 211,
 "OnboardingDataDocumentTypeID": 7,
 "Name": "Driving License",
 "Description": "Driving License",
 "Mandatory": true
}
Field Data Type
OnboardingTypeID Int 32
OnboardingDataDocumentTypeID Int 32
Name Text 300
Description Text 500
Mandatory Boolean