Get Co-signer Details
Action: POST
Endpoint: /api/CoreCredit/AccountHolders/GetCosignerDetails
Use this API to retrieve co-signer data such as PII (personal identification information), contact information, demographic details, and the bankruptcy notification date and indicator (if any).
Request fields details
| Fields | Description |
|---|---|
|
Source string Mandatory |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
|
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
|
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
|
CurrencyCode string Optional |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10 |
|
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
|
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
|
ExternalIP string Mandatory |
IP Address of end user of API Allowable Values: 50 |
|
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
|
APIVersion string Mandatory |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
|
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
|
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
|
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
|
AccountID string Mandatory |
Account ID represents Unique Identity of Account Format:XXXXX Example:12345 Allowable Values: 25 |
Sample request body
{
"Source": "Web",
"IPAddress": "10.120.0.1",
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.120.0.0",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"AccountID": "167573"
}
Response fields details
| Fields | Description |
|---|---|
|
CustomerID string |
Description:Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123 Allowable Values: 25 |
|
CosignerTitle string |
Description: Cosigner's Title like MR or MRS. Valid Values:Refer Appendix section 5.7 Format: xx Example: 01 = MR, 16 = Col, 17 = Judge Allowable Values: 15 |
|
CosignerFirstName string |
Description: Cosigner's First Name Valid Values:A-Z,0-9 Format:XXXXX Example:User1 Allowable Values: 50 |
|
CosignerMiddleName string |
Description: Cosigner's Middle Name Valid Values:A-Z,0-9 Format:XXXXX Example:User1 Allowable Values: 50 |
|
CosignerLastName string |
Description: Cosigner's Last Name Valid Values:A-Z,0-9 Format:XXXXX Example:User1 Allowable Values: 50 |
|
CosignerAddress1 string |
Cosigner's Address Line 1 Allowable Values: 50 |
|
CosignerAddress2 string |
Cosigner's Address Line 2 Allowable Values: 50 |
|
CosignerCity string |
Cosigner's City. Allowable Values: 25 |
|
CosignerState string |
Description: Cosigner’s State Valid Values:A-Z,0-9 Format:XXXXX Example:abcd Allowable Values: 25 |
|
CosignerCountry string |
Description: Cosigner’s Country Valid Values:A-Z,0-9 Format:XXXXX Example:abcd Allowable Values: 15 |
|
CosignerPostalCode string |
Description: Cosigner’s Postal code Valid Values:0-9 Format:XXXXX Example:99501 Allowable Values: 9 |
|
CosignerHomePhoneNumber string |
Description: Cosigner's Home Phone Number Valid Values:0-9 Format:XXXXXXXXX Example:7548264758 Allowable Values: 11 |
|
CosignerWorkPhoneNumber string |
Description: Cosigner's work phone number Valid Values:0-9 Format:XXXXXXXXX Example:784565412 Allowable Values: 11 |
|
CosignerMobileNumber string |
Description: Cosigner's Mobile phone number Valid Values:0-9 Format:XXXXXXXXX Example:784565412 Allowable Values: 11 |
|
CosignerOtherPhoneNumber string |
Description: Cosigner's Other phone number Valid Values:0-9 Format:XXXXXXXXX Example:784565412 Allowable Values: 11 |
|
CosignerFaxNumber string |
Description: Cosigner's Fax number Valid Values:0-9 Format:XXXXXXXXX Example:784565412 Allowable Values: 11 |
|
CosignerCreditFilePhone string |
Cosigner's Credit File Phone number. Allowable Values: 11 |
|
CosignerAlternatePhone string |
Description: Cosigner's Alternate phone number Valid Values:0-9 Format:XXXXXXXXX Example:784565412 Allowable Values: 11 |
|
CosignerEmailID string |
Description: Cosigner's email ID associated with additional address details Valid Values: 0-9 a-z Format:xxx@xxx.xxx Example:abc@xyz.com Allowable Values: 30 |
|
CosignerDateofBirth datetime |
Description: Cosigner’s Date of Birth Valid Values: Format:MM/DD/YYYY Example:01/02/1988 |
|
CosignerResidenceType string |
Description: Cosigner residence type Valid Values: Refer Appendix section 5.15 Format: xxxx Example: Own Allowable Values: 10 |
|
CosignerBadAddress integer |
Description: Identifies the Cosigner's provided address is a bad address. Valid Values:0 or 1 Format: x Example: 1 |
|
CosignerMaritalStatus string |
Description: Cosigner's Marital Status Valid Values: 0,1 Format: x Example: 0- No, 1 - Yes Allowable Values: 1 |
|
CosignerSSN string |
Description: Cosigner’s Social Security Number Valid Values:0-9 Format:XXXXXXXXX Example:XXXXX8796 Allowable Values: 12 |
|
CosignerGender string |
Description: Gender of Cosigner Valid Values: A-Z Format: xxxxxxx Example: Male Allowable Values: 5 |
|
CosignerCeaseAndDesist integer |
Description: This tag reflects whenever Cosigner is ceased or desist the CoreCOLLECT user need not follow up the mapped account holder thus all the credentials of the mapped account holders are erased from the dialer file using this flag. Valid Values: 0 or 1 Format: x Example: 1 Allowable Values: 1 |
|
CeaseAndDesistCommunication string |
Values: All Communication Litigation Phone and Email Phone and Mail Email and Mail Phone Only Email Only Mail Only ATTO Allowable Values: 20 |
|
CosignerBankruptcy integer |
Description: Cosigner's Flag for Bankruptcy Valid Values: 0,1 Format: x Example: 0-no, 1-yes Allowable Values: 1 |
|
CosignerBankruptcyNotificationDate datetime |
Description: Cosigner's bankruptcy notification date. Valid Values: 0-9 Format:MM/DD/YYYY HH:MM:SS Example:12/20/2019 12:18:19 |
|
CosignerDeceased integer |
Flag to mark deceased. |
|
CosignerDeceasedNotificationDate datetime |
Description: Date when deceased is notified Format:MM/DD/YYYY Example:02/20/2020 Condition: Mandatory for deceased account |
|
HomePhoneNumberTechType integer |
Description: Tech Type of Home Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129 |
|
MobileNumberTechType integer |
Description: Tech Type of Mobile Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129 |
|
WorkPhoneNumberTechType integer |
Description: Tech Type of Work Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129 |
|
OtherPhoneNumberTechType integer |
Description: Tech Type of other Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129 |
|
FaxNumberTechType integer |
Description: Tech Type of Fax Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129 |
|
CreditFilePhoneTechType integer |
Description: Tech Type of Credit File Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129 |
|
AlternatePhoneTechType integer |
Description: Tech Type of Alternate Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129 |
|
CosignerConsumerInformationIndicator string |
CosignerConsumerInformationIndicator Allowable Values: 15 |
|
CosignerFraudVictim boolean |
Description: Identifies the Cosigner as Fraud victim. Valid Values:0 or 1 Format: x Example: 1 |
|
CosignerAddressLine1 string |
Description: Cosigner's Address line1 Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 50 |
|
CosignerAddressLine2 string |
Description: Cosigner's Address line2 Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 50 |
|
CosignerCeaseDesistCommunication string |
Description: Cosigner's Cease and Desist communication Valid Values: Available in Appendix section 5.37 Format: xxxxxx Example: litigation, Phone and Mail etc Allowable Values: 20 |
|
CosignerMobileCarrier string |
This tag reflect the co-signer Mobile carrier company Valid Values:A-z, 0-9 Format:XXXXXXXX Example:Vodafone Allowable Values: 25 |
|
CosignerStatus string |
Description:Status of Cosigner Valid Values: 0-1 Format: 0 Example: 1 Allowable Values: 1 |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"CustomerID": "167383",
"CosignerTitle": null,
"CosignerFirstName": "Bhushan",
"CosignerMiddleName": null,
"CosignerLastName": "Waje",
"CosignerSNSuffix": "ii",
"CosignerAddressLine1": "ISC Software Private Limited",
"CosignerAddressLine2": "kush",
"CosignerCity": "Navi Mumbai",
"CosignerState": "AS",
"CosignerCountry": "US",
"CosignerPostalCode": "400614",
"CosignerHomePhoneNumber": "5698756891",
"CosignerWorkPhoneNumber": "5871458796",
"CosignerMobileNumber": "5698758795",
"CosignerOtherPhoneNumber": null,
"CosignerFaxNumber": null,
"CosignerCreditFilePhone": null,
"CosignerAlternatePhone": null,
"CosignerEmailID": "bhushan.waje@corecard.com",
"CosignerDateofBirth": "08/03/1993 00:00:00",
"CosignerResidenceType": "O",
"CosignerBadAddress": 0,
"CosignerMaritalStatus": null,
"CosignerSSN": null,
"CosignerGender": null,
"CosignerCeaseAndDesist": 0,
"CosignerCeaseDesistCommunication": null,
"CosignerBankruptcy": 0,
"CosignerBankruptcyNotificationDate": null,
"CosignerDeceased": 0,
"CosignerDeceasedNotificationDate": null,
"CosignerMobileCarrier": null,
"HomePhoneNumberTechType": null,
"MobileNumberTechType": null,
"WorkPhoneNumberTechType": null,
"OtherPhoneNumberTechType": null,
"FaxNumberTechType": null,
"CreditFilePhoneTechType": null,
"AlternatePhoneTechType": null,
"SupressEmail": "0",
"EmailMarketingOptOutPA": "0",
"CosignerConsumerInformationIndicator": null,
"CosignerFraudVictim": false,
"CosignerStatus": "1"
}
}