Thursday, November 21, 2024

Client - Prospect
Action:
GET
Method:
GET
URL: /api/v1/client/prospect/get
Description: Fetch a Client Prospect record based on the Client Prospect ID
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 ClientProspectID Int32 Client Prospect Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client Prospect
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450032,
 "InterfaceReference": "ABC",
 "LastName": "Power",
 "FirstName": "Jordan",
 "MiddleName": "AL",
 "Email": "testaccount@kycglobal.com",
 "MobilePhone": "+447829900800",
 "OnboardingTypeID": 200,
 "ClientEntityID": 6865,
 "ProspectStatus": 1,
 "AllowManageProspect": false,
 "AllowKYBLookup": false,
 "UseDefaultEmail": false,
 "DefaultEmailId": "",
 "IsImported": 0,
 "HandledByGroupID": 202,
 "HandledByUserID": 137,
 "ProspectAddedDate": "2020-08-03 00:00:00",
 "OnboardingTypeName": "Person",
 "HandledByUserGroupName": "Admin Group",
 "HandledByUserName": "Admin STAGING",
 "ClientEntityInterfaceReference": "64B2A700-9B7D-4D52-A598-98085D98E850",
 "ClientName": "Singapore Office",
 "HandledBySupervisorUserID": 0,
 "HandledBySupervisorUserName": "",
 "HandledByManagerUserID": 0,
 "HandledByManagerUserName": "",
 "HandledByDirectorUserID": 0,
 "HandledByDirectorUserName": ""
}
Field Data Type
BusinessUnitID Int 32
ProspectID Int32
InterfaceReference Text 50
LastName Text 510
FirstName Text 510
MaidenName Text 510
Email Text 500
MobilePhone Text 50
OnboardingTypeID Int32
ClientEntityID Int32
ProspectStatus Byte
AllowManageProspect Boolean
AllowKYBLookup Boolean
UseDefaultEmail Boolean
DefaultEmailId Text 500
IsImported Boolean
HandledByGroupID Int16
HandledByUserID Int16
ProspectAddedDate Date
OnboardingTypeName Text 300
HandledByUserGroupName Text 300
HandledByUserName Text 300
ClientEntityInterfaceReference Text 100
ClientName Text 100
HandledBySupervisorUserID Int16
HandledBySupervisorUserName Text 300
HandledByManagerUserID Int16
HandledByManagerUserName Text 300
HandledByDirectorUserID Int16
HandledByDirectorUserName Text 300
Action:
SEARCH
Method:
GET
URL: /api/v1/client/prospect/search
Description: Search for Client Prospects records
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 SearchString Text 255 Search string
Params SearchOn Byte 0 = Last name, 1 = First name, 2 = Middle name, 3 = Client Prospect ID, 4 = Interface Reference
Params SearchType Byte 0 = Starts with, 1 = Contains
Params SearchStatus Byte 0 = Inactive, 1 = Active, 2 = All
Params IsImported Boolean Is Imported (optional - value defaulted to null if not provided)
Params HandlerGroup Int32 Handler Group (optional - value defaulted to null if not provided)
Params HandlerUser Int32 Handler User (optional - value defaulted to null if not provided)
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of one or many Client Prospects
[{
 "BusinessUnitID": 10,
 "ClientProspectID": 450048,
 "InterfaceReference": "",
 "LastName": "Johnson",
 "FirstName": "Boris",
 "MiddleName": "",
 "Email": "kycadmin@kycglobal.com",
 "MobilePhone": "07729855584",
 "OnboardingTypeID": 205,
 "ClientEntityID": 6871,
 "ProspectStatus": 1,
 "AllowManageProspect": false,
 "AllowKYBLookup": false,
 "UseDefaultEmail": false,
 "DefaultEmailId": "",
 "IsImported": 0,
 "HandledByGroupID": 212,
 "HandledByUserID": 137,
 "ProspectAddedDate": "2020-08-06 00:00:00",
 "OnboardingTypeName": "Beneficial Owner",
 "HandledByUserGroupName": "Handler Group",
 "HandledByUserName": "Administrator",
 "ClientEntityInterfaceReference": "91A92AF1-7533-4FFC-BB78-79652965BCF0",
 "ClientName": "Singapore Office",
 "HandledBySupervisorUserID": 0,
 "HandledBySupervisorUserName": "",
 "HandledByManagerUserID": 0,
 "HandledByManagerUserName": "",
 "HandledByDirectorUserID": 0,
 "HandledByDirectorUserName": ""
}]
Field Data Type
BusinessUnitID Int 32
ProspectID Int32
InterfaceReference Text 50
LastName Text 510
FirstName Text 510
MaidenName Text 510
Email Text 500
MobilePhone Text 50
OnboardingTypeID Int32
ClientEntityID Int32
ProspectStatus Byte
AllowManageProspect Boolean
AllowKYBLookup Boolean
UseDefaultEmail Boolean
DefaultEmailId Text 500
IsImported Boolean
HandledByGroupID Int16
HandledByUserID Int16
ProspectAddedDate Date
OnboardingTypeName Text 300
HandledByUserGroupName Text 300
HandledByUserName Text 300
ClientEntityInterfaceReference Text 100
ClientName Text 100
HandledBySupervisorUserID Int16
HandledBySupervisorUserName Text 300
HandledByManagerUserID Int16
HandledByManagerUserName Text 300
HandledByDirectorUserID Int16
HandledByDirectorUserName Text 300
Action:
ADD
Method:
POST
URL: /api/v1/client/prospect/add
Description: Add Client Prospect
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body IncludeDetailInResult Boolean Details to be included in the result (True / False)
Body InterfaceReference Text 50 Interface reference of the Prospect
Body FirstName Text 510 First Name
Body LastName Text 510 Last Name
Body MiddleName Text 510 Middle Name
Body Email Text 500 Email Address
Body MobilePhone Text 50 Mobile Number
Body OnboardingTypeID Int32 Onboarding Type Id
Body ClientEntityID Int32 Client Entity Id the prospect is associated with or leave blank
Body ProspectStatus Byte 0 = Inactive, 1 = Active
Body AllowManageProspect Boolean Allow Manage Prospect (optional)
Body AllowKYBLookup Boolean Allow KYB Lookup (optional)
Body UseDefaultEmail Boolean Use Default Email Id Flag (optional)
Body DateAdded Date Date the prospect was added (yyyy-mm-dd or leave blank)
Body HandledByUserGroupID Int16 User Group Identifier of the user handling the prospect
Body HandledByUserID Int16 User Identifier
Body HandledBySupervisorUserID Int16 Handled by Supervisor User Identifier
Body HandledByManagerUserID Int16 Handled by Manager User Identifier
Body HandledByDirectorUserID Int16 Handled by Director User Identifier
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding added.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450134,
 "InterfaceReference": "MYREF1234",
 "LastName": "PUTIN",
 "FirstName": "VLADIMIR",
 "MiddleName": "",
 "Email": "vputin@gmail.com",
 "MobilePhone": "007213654879",
 "OnboardingTypeID": 200,
 "ClientEntityID": 5491,
 "ProspectStatus": 1,
 "AllowManageProspect": false,
 "AllowKYBLookup": false,
 "UseDefaultEmail": false,
 "DefaultEmailId": "",
 "IsImported": 0,
 "HandledByGroupID": 200,
 "HandledByUserID": 122,
 "ProspectAddedDate": "2020-09-29 00:00:00",
 "OnboardingTypeName": "Person",
 "HandledByUserGroupName": "Administration",
 "HandledByUserName": "Chandramohan STAGING",
 "ClientEntityInterfaceReference": "123456789",
 "ClientName": "Singapore Office",
 "HandledBySupervisorUserID": 0,
 "HandledBySupervisorUserName": "",
 "HandledByManagerUserID": 0,
 "HandledByManagerUserName": "",
 "HandledByDirectorUserID": 0,
 "HandledByDirectorUserName": ""
}
Field Data Type
ClientProspect Collection
 Same as Get Method results above.
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/prospect/update
Description: Update Client Prospect
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectID Int32 Client Prospect Id to be updated
Body IncludeDetailInResult Boolean Details to be included in the result (True / False)
Body InterfaceReference Text 50 Interface reference of the Prospect
Body FirstName Text 510 First Name
Body LastName Text 510 Last Name
Body MiddleName Text 510 Middle Name
Body Email Text 500 Email Address
Body MobilePhone Text 50 Mobile Number
Body OnboardingTypeID Int32 Onboarding Type Id
Body ClientEntityID Int32 Client Entity Id the prospect is associated with or leave blank
Body ProspectStatus Byte 0 = Inactive, 1 = Active
Body AllowManageProspect Boolean Allow Manage Prospect (optional)
Body AllowKYBLookup Boolean Allow KYB Lookup (optional)
Body UseDefaultEmail Boolean Use Default Email Id Flag (optional)
Body DateAdded Date Date the prospect was added (yyyy-mm-dd or leave blank)
Body HandledByUserGroupID Int16 User Group Identifier of the user handling the prospect
Body HandledByUserID Int16 User Identifier
Body HandledBySupervisorUserID Int16 Handled by Supervisor User Identifier
Body HandledByManagerUserID Int16 Handled by Manager User Identifier
Body HandledByDirectorUserID Int16 Handled by Director User Identifier
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding updated.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450134,
 "InterfaceReference": "MYREF1234",
 "LastName": "PUTIN",
 "FirstName": "VLADIMIR",
 "MiddleName": "F",
 "Email": "vputin@gmail.com",
 "MobilePhone": "007213654879",
 "OnboardingTypeID": 200,
 "ClientEntityID": 5491,
 "ProspectStatus": 1,
 "AllowManageProspect": false,
 "AllowKYBLookup": false,
 "UseDefaultEmail": false,
 "DefaultEmailId": "",
 "IsImported": 0,
 "HandledByGroupID": 200,
 "HandledByUserID": 122,
 "ProspectAddedDate": "2020-09-29 00:00:00",
 "OnboardingTypeName": "Person",
 "HandledByUserGroupName": "Administration",
 "HandledByUserName": "Chandramohan STAGING",
 "ClientEntityInterfaceReference": "123456789",
 "ClientName": "Singapore Office",
 "HandledBySupervisorUserID": 0,
 "HandledBySupervisorUserName": "",
 "HandledByManagerUserID": 0,
 "HandledByManagerUserName": "",
 "HandledByDirectorUserID": 0,
 "HandledByDirectorUserName": ""
}
Field Data Type
ClientProspect Collection
 Same as Get Method results above.
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/prospect/delete
Description: Delete Client Prospect
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectID Int32 Client Prospect Id to be updated
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Prospect deleted.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450134,
 "InterfaceReference": "MYREF1234",
 "LastName": "PUTIN",
 "FirstName": "VLADIMIR",
 "MiddleName": "F",
 "Email": "vputin@gmail.com",
 "MobilePhone": "007213654879",
 "OnboardingTypeID": 200,
 "ClientEntityID": 5491,
 "ProspectStatus": 1,
 "AllowManageProspect": false,
 "AllowKYBLookup": false,
 "UseDefaultEmail": false,
 "DefaultEmailId": "",
 "IsImported": 0,
 "HandledByGroupID": 200,
 "HandledByUserID": 122,
 "ProspectAddedDate": "2020-09-29 00:00:00",
 "OnboardingTypeName": "Person",
 "HandledByUserGroupName": "Administration",
 "HandledByUserName": "Chandramohan STAGING",
 "ClientEntityInterfaceReference": "123456789",
 "ClientName": "Singapore Office",
 "HandledBySupervisorUserID": 0,
 "HandledBySupervisorUserName": "",
 "HandledByManagerUserID": 0,
 "HandledByManagerUserName": "",
 "HandledByDirectorUserID": 0,
 "HandledByDirectorUserName": ""
} }
Field Data Type
ClientProspect Collection
 Same as Get Method results above.
Action:
SEARCHPAGED
Method:
GET
URL: /api/v1/client/prospect/searchpaged
Description: Search for Client Prospects records with pagination enabled
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 SearchString Text 255 Search string
Params SearchOn Byte 0 = Last name, 1 = First name, 2 = Middle name
Params SearchType Byte 0 = Starts with, 1 = Contains
Params SearchStatus Byte 0 = Inactive, 1 = Active, 2 = All
Params IsImported Boolean Is Imported (optional - value defaulted to null if not provided)
Params HandlerGroup Int32 Handler Group (optional - value defaulted to null if not provided)
Params HandlerUser Int32 Handler User (optional - value defaulted to null if not provided)
Params CurrentPage Int32 Page Index used for the pagination
Params PageSize Int32 Page Size to be returned as part of response for the pagination
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of one or many Client Prospects
{
 "TotalRecords":100,
 "Data": [
 {
 "BusinessUnitID": 10,
 "ClientProspectID": 450048,
 "InterfaceReference": "",
 "LastName": "Johnson",
 "FirstName": "Boris",
 "MiddleName": "",
 "Email": "kycadmin@kycglobal.com",
 "MobilePhone": "07729855584",
 "OnboardingTypeID": 205,
 "ClientEntityID": 6871,
 "ProspectStatus": 1,
 "AllowManageProspect": false,
 "AllowKYBLookup": false,
 "UseDefaultEmail": false,
 "DefaultEmailId": "",
 "IsImported": 0,
 "HandledByGroupID": 212,
 "HandledByUserID": 137,
 "ProspectAddedDate": "2020-08-06 00:00:00",
 "OnboardingTypeName": "Beneficial Owner",
 "HandledByUserGroupName": "Handler Group",
 "HandledByUserName": "Administrator",
 "ClientEntityInterfaceReference": "91A92AF1-7533-4FFC-BB78-79652965BCF0"
 }
 ]
}
Field Data Type
TotalRecords Int 32
BusinessUnitID Int 32
ProspectID Int32
InterfaceReference Text 50
LastName Text 510
FirstName Text 510
MaidenName Text 510
Email Text 500
MobilePhone Text 50
OnboardingTypeID Int32
ClientEntityID Int32
ProspectStatus Byte
AllowManageProspect Boolean
AllowKYBLookup Boolean
UseDefaultEmail Boolean
DefaultEmailId Text 500
IsImported Boolean
HandledByGroupID Int16
HandledByUserID Int16
ProspectAddedDate Date
OnboardingTypeName Text 300
HandledByUserGroupName Text 300
HandledByUserName Text 300
ClientEntityInterfaceReference Text 100