Tuesday, July 16, 2024

Client - GDC Upload
Action:
Import
Method:
POST
URL: /api/v1/client/gdcupload/Import
Description: Import of GDC data in bulk
Uploading of GDC data using this method should be batched into manageable blocks of 5000 records.
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/json
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params FileName String Name of the imported file (optional)
Params ActionUserID Int16 Identifier of the User performing action.
Params ReturnFormat String Json or Xml
Body raw Json Json Collection of Input Data
Input Data: {
 "ClientGDCDataImportRow":[
  {
   "RawrecordID": "1515622UK",
   "Rawcompletename": "Anthony White",
   "RawfirstName": "Anthony",
   "RawlastName": "White",
   "RawlastNameMaternal": "White",
   "Rawdob": "10/08/1975",
   "RawHouseNumber": "",
   "RawhouseNumberAddition": "",
   "Rawstreet": "",
   "RawaddressLine1": "Via Perez 27",
   "Rawcity": "Ortana",
   "Rawprovince": "ITALIA",
   "RawpostalCode": "66026",
   "RawcountryCode": "IT",
   "RawnationalID": "",
   "RawphoneNumber": "",
   "RawEmailAddress": "anothinywhite@abc.com",
   "RawHandledbyUserGroupID": "665",
   "RawHandledbyUserID": "733",
   "RawInternalParticipantID": "142356",
   "RawGSCustomerID": "TEST32"
  }
 ]
}
Return Data: Json or XML of GDC Upload
{
 "Reference": "d4ca2150-29dd-40cb-8f3d-6ddf7f8408bd",
 "FileName": "ExportTemplate.xls",
 "FileRows": 1,
 "LoadingStatus": 1
}
Field Data Type
Reference Text 100
FileName Text 100
FileRows Int 32
LoadingStatus Byte
Action:
SendEmail
Method:
POST
URL: /api/v1/client/gdcupload/SendEmail
Description: Send the Data collection form emails to the prospects
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/json
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params Reference String Data Loading Reference of uploaded file
Params ActionUserID Int16 Identifier of the User performing action.
Params ReturnFormat String Json or Xml
Body raw Json Json Collection of Input Data
Input Data: {
 "OnboardingTypeDetailList":[
  {
   "OnboardingTypeID": 234,
   "EmailTemplateID": 23
  },
  {
   "OnboardingTypeID": 342,
   "EmailTemplateID": 13
  }
 ]
}
Return Data: Json or XML of GDC Upload
{
 "Reference": "d4ca2150-29dd-40cb-8f3d-6ddf7f8408bd",
 "FileName": "ExportTemplate.xls",
 "FileRows": 1,
 "LoadingStatus": 1,
 "Errors":[
  {
   "RowNumber": 1,
   "Message": "Failed to update data"
  }
 ],
}
Field Data Type
Reference Text 100
FileName Text 100
FileRows Int 32
LoadingStatus Byte
Errors Collection
RowNumber Int 32
Message Text 100
Action:
GET
Method:
Export
URL: /api/v1/client/gdcupload/Export
Description: Fetch a GDC Data extract
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 SearchTerm String Search Term
Params SearchOn Byte Search On (0 = Reference, 1 = File Name)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of GDC Data Extract
{
 "ClientGDCUploadExportRow":[
  {
   "OnboardingTypeID": 133,
   "OnboardingTypeName": "OT Name",
   "ProspectName": "White",
   "Stage": "Data Collection",
   "Status": 1,
   "Days Since Last Action": 5,
   "Prospect Reference": "ABC5643",
   "Customer Name": "CustName",
   "Country of Residency of the Prospect (Participant)": "Malta",
   "Date When Added To RiskScreen": "2020-08-03 00:00:00",
   "Date Onboarded": "2020-08-07 00:00:00",
   "Handler Group Name": "HandlingGroup",
   "Handler Group ID": 665,
   "Handler User Name": "HandlingUserName"
   "Handler User ID": 345,
   "Business Unit ID": 10
  }
 ]
}
Field Data Type
OnboardingTypeID Int 32
OnboardingTypeName Text 300
ProspectName Text 1530
Stage Text 100
Status Int 16
Days Since Last Action Int 32
Prospect Reference Text 100
Customer Name Text 100
Country of Residency of the Prospect (Participant) Text 300
Date When Added To RiskScreen Date Time
Date Onboarded Date Time
Handler Group Name Text 300
Handler Group ID Int 32
Handler User Name Text 300
Handler User ID Int 32
Business Unit ID Int 32
Action:
GET
Method:
Summary
URL: /api/v1/client/gdcupload/GetRecordCountSummary
Description: Fetch a GDC record count per OnboardingType
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 SearchTerm String Search Term
Params SearchOn Byte Search On (0 = Reference, 1 = File Name)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of GDC record count summary
[
 {
  "ClientID": 234,
  "ClientName": "TestClient",
  "BusinessUnitID": 10,
  "BusinessUnitName": "Default",
  "DataUploadID": 133,
  "Reference": "d4ca2150-29dd-40cb-8f3d-6ddf7f8408bd",
  "FileName": "ExportTemplate.xls",
  "OnboardingTypeID": 133,
  "OnboardingTypeName": "OT Name",
  "GDCJourneyType": "Journey_1",
  "RecordCount": 234
 },
 {
  "ClientID": 234,
  "ClientName": "TestClient",
  "BusinessUnitID": 10,
  "BusinessUnitName": "Default",
  "DataUploadID": 133,
  "Reference": "d4ca2150-29dd-40cb-8f3d-6ddf7f8408bd",
  "FileName": "ExportTemplate.xls",
  "OnboardingTypeID": 321,
  "OnboardingTypeName": "Onboarding Type Name",
  "GDCJourneyType": "Journey_2.1",
  "RecordCount": 122
 }
]
Field Data Type
ClientID Int16
ClientName Text 100
BusinessUnitID Int 32
BusinessUnitName Text 100
DataUploadID Text 100
Reference Text 100
FileName Text 100
OnboardingTypeID Int 32
OnboardingTypeName Text 100
GDCJourneyType Text 100
RecordCount Int 32
Action:
GET
Method:
GetDetails
URL: /api/v1/client/gdcupload/getdetails
Description: Fetch a GDC Data upload details
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 SearchTerm String Search Term
Params SearchOn Byte Search On (0 = Reference, 1 = File Name)
Params Status Byte Status (0 = ALL, 1 = Pending Data, 2 = Successful Data, 3 = Failed Data)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of GDC Upload Data
{
 "ClientGDCDataImportDetail":[
  {
   "ClientID": 123,
   "ClientName": "TestClient",
   "BusinessUnitID": 10,
   "BusinessUnitName": "Default",
   "Reference": "9c1a4bee-0934-46b9-9806-343e1a7ac7e9",
   "ClientGDCDataImportDetailItem":[
    {
     "Status": "1",
     "Message": "INSERT/ClientProspectID : 513135 ",
     "recordID": "1515622UK",
     "completename": "Anthony White",
     "firstName": "Anthony",
     "lastName": "White",
     "lastNameMaternal": "White",
     "dob": "10/08/1975",
     "houseNumber": "",
     "houseNumberAddition": "",
     "street": "",
     "addressLine1": "Via Perez 27",
     "city": "Ortana",
     "province": "ITALIA",
     "postalCode": "66026",
     "countryCode": "IT",
     "nationalID": "",
     "phoneNumber": "",
     "EmailAddress": "anothinywhite@abc.com",
     "HandledbyUserGroupID": "665",
     "HandledbyUserID": "733",
     "InternalParticipantID": "142356",
     "GSCustomerID": "TEST32"
     "BusinessUnitID": "10"
    }
   ]
  }
 ]
}
Field Data Type
ClientGDCDataImportDetail Collection
ClientID Int16
ClientName Text 100
BusinessUnitID Int 32
BusinessUnitName Text 100
Reference Text 100
ClientGDCDataImportDetailItem Collection
Status Text 100
Message Text 100
recordID Text 100
completename Text 100
firstName Text 100
lastName Text 100
lastNameMaternal Text 100
dob Text 100
houseNumber Text 100
houseNumberAddition Text 100
street Text 100
addressLine1 Text 100
city Text 100
province Text 100
postalCode Text 100
countryCode Text 100
nationalID Text 100
phoneNumber Text 100
EmailAddress Text 100
HandledbyUserGroupID Text 100
HandledbyUserID Text 100
InternalParticipantID Text 100
GSCustomerID Text 100
Action:
GET
Method:
Summary
URL: /api/v1/client/gdcupload/StagingGetSummary
Description: Fetch a Client GDC Upload record based on the Data Upload Identifier
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 SearchTerm String Search Term
Params SearchOn Byte Search On (0 = Reference, 1 = File Name)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client GDC Upload
{
 "BusinessUnitID": 10,
 "Reference": "d4ca2150-29dd-40cb-8f3d-6ddf7f8408bd",
 "FileName": "ExportTemplate.xls",
 "RequestedOn": "2020-08-03 00:00:00",
 "Status": 1,
 "PendingRows": "Jordan",
 "SuccessfulRows": "AL",
 "FailedRows": "testaccount@kycglobal.com"
 "Type": 0
}
Field Data Type
BusinessUnitID Int 32
Reference Text 100
FileName Text 100
RequestedOn Date Time
Status Int 16
PendingRows Int 32
SuccessfulRows Int 32
FailedRows Int 32
Type Int 16