Coresmen API

Description

This API is used to record the loan information onto the FIs system of record, their core, the data is transferred from Q2 Origination to the financial Institution's core systems.

Definition

POST {{Org_URL}}/services/apexrest/q2adapters/v1/coresmen/invokeIntegrationService

Authentication Type

Basic Salesforce Auth 2.0

See this link for SFDC Documentation: https://help.salesforce.com/articleView?id=remoteaccess_oauth_web_server_flow.htm&type=5

Parameters

Request Header Parameters

The following table provides the details of the request header parameters used by this web service:

Key	Value
Content-Type	application/JSON
charset	UTF-8
Accept	application/JSON

Request Body Parameters

The following table provides the details of the request body parameters used by this web service:

Field Name	Type
integrationFamily	String
apiType	String
executionPriority	String
idsForFiltersMap	Object
optionalRequestParamsMap	Object

Error Messages

When you use this web service you can receive the possible error messages as shown in the following table:

Status Code	Error Message
500	Internal Server Error.

The sample request to be sent is as shown in the following block:

Sample Request

Account Number Request:

{
    "integrationFamily": "Coresmen",
    "apiType": "Account Number Request",
    "executionPriority": "1",
    "idsForFiltersMap": {
        "applicationId": "{{Application_Id}}"    }
}


Account Search Request:
{
"executionPriority": "1",
"idsForFiltersMap": {
    "applicationId" : "{{Application_Id}}"},
"optionalRequestParamsMap":{"searchByOption":"ACCOUNT#"},
"apiType": "Account Search Request",
"integrationFamily": "Coresmen"}


Create Customer Request:
{
  "executionPriority": "1",
  "idsForFiltersMap": {
    "accountId": "{{BusinessAccount_Id_1}}",
    "businessInfoId":"{{BusinessInfo_Id}}"  },
  "apiType": "Create Customer Request",
  "integrationFamily": "Coresmen"}

Search Customer Request:
{
"executionPriority": "1",
"idsForFiltersMap": {
"accountId": "{{BusinessAccount_Id_1}}",
"businessInfoId":"{{BusinessInfo_Id}}"},
"optionalRequestParamsMap":{ "searchByOption":"TAXID"},
"apiType": "Search Customer Request",
"integrationFamily": "Coresmen"}


Create Account Request:
{
"executionPriority": "1",
"idsForFiltersMap": {
"applicationId": "{{Application_Id}}",
"partiesId":["{{BusinessParty_Id_1}}","{{IndividualParty_Id_1}}"]
},
"optionalRequestParamsMap":{},
"apiType": "Create Account Request",
"integrationFamily": "Coresmen"}


Create Collateral Request:
{
"executionPriority": "1",
"idsForFiltersMap": {
"collateralIds": ["{{Collateral_ID_Business}}"],
"applicationId": "{{Application_Id}}"},
"optionalRequestParamsMap":{},
"apiType": "Create Collateral Request",
"integrationFamily": "Coresmen"}

Update Collateral Request:
{
"executionPriority": "1",
"idsForFiltersMap": {
"collateralIds": ["{{Collateral_ID_Business}}"],
"applicationId": "{{Application_Id}}"},
"optionalRequestParamsMap":{},
"apiType": "Update Collateral Request",
"integrationFamily": "Coresmen"}