Developer API

The Credit Repair Cloud Developer API is designed for experienced web developers proficient in XML. If you are new to REST, you can learn basics at http://en.wikipedia.org/wiki/REST or look at options for Zapier

Examples


1. Insert Record (Lead/Client)


Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: insertRecord

XML Format:

https://app.creditrepaircloud.com/api/lead/insertRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

<crcloud>
  <lead>
    <type>Client</type>
    <firstname>Scott</firstname>
    <lastname>James</lastname>
    <middlename>G</middlename>
    <suffix>Mr</suffix>
    <email>test@test.com</email>
    <phone_home>9999999999</phone_home>
    <phone_mobile>9999999999</phone_mobile>
    <phone_work>9999999999</phone_work>
    <phone_work_ext>123</phone_work_ext>
    <fax>7777777777</fax>
    <street_address>street address</street_address>
    <city>New York</city>
    <state>NY</state>
    <post_code>10007</post_code>
    <ssno>545665656</ssno>
    <birth_date>10/31/1983</birth_date>
    <memo>test</memo>
    <previous_mailing_address>test</previous_mailing_address>
    <previous_city>New York</previous_city>
    <previous_state>NY</previous_state>
    <previous_post_code>10007</previous_post_code>
    <client_assigned_to>team member1,team member2</client_assigned_to>
    <client_portal_access>on</client_portal_access>
    <client_userid>test@test.com</client_userid>
    <client_agreement>Sample Agreement</client_agreement>
    <send_setup_password_info_via_email>yes</send_setup_password_info_via_email>
    <referred_by_firstname>Freddy</referred_by_firstname>
    <referred_by_lastname>Katz</referred_by_lastname>
    <referred_by_email>demo@demo.com</referred_by_email>
  </lead>
</crcloud>

Request Parameters

Parameter Data Type Description
apiauthkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData* String This is an XML string and the format should be in XML format.
type* String

Client status type should be in string format as per below.

Client
Lead
Lead/Inactive
Inactive
Suspended

Note: To add your own custom status. pls login and go to https://app.creditrepaircloud.com/mycompany/clientstatus and Copy status name in xml
firstname* String First name should be in string format.
lastname* String Last name should be in string format.
middlename String Middle name should be in string format.
suffix String Suffix should be in string format.
email Email Email should be in email format.
phone_home Integer Home Phone should be in 10 digit number format.
phone_work Integer Work Phone should be in 10 digit number format.
phone_mobile Integer Mobile Phone should be in 10 digit number format.
street_address String Street Address should be in string format.
city String City should be in string format.
state String State should be in string format.
post_code Integer Post code should be in number format.
ssno Integer Social Security no.should be in 9 digit number format.
birth_date Date Birth date should be in in mm/dd/yyyy format.
memo String Memo should be in string format.
previous_mailing_address String Previous mailing address should be in string format. Previous mailing address (only if at current mailing address for less than 2 years)
previous_city String Previous City should be in string format.
previous_state String Previous State should be in string format.
previous_post_code Integer Previous post code should be in number format.
client_assigned_to String Name of team members with comma separator for assing team members to client.
Note: Pls login and go to https://app.creditrepaircloud.com/mycompany/team and Copy team member name in xml
client_portal_access on or off Portal Access for client. Values should be on or off
https://secureclientaccess.com
on = Client can access portal
off = Client can not access portal
client_userid Email Userid same as email
Note: Only accepted if client_portal_access is on
client_agreement String Agreement name should be in alphanumeric string
Note: Pls login and go to https://app.creditrepaircloud.com/mycompany/agreement and Copy agreement name in xml Note: Only accepted if client_portal_access is on
send_setup_password_info_via_email yes or no yes = System will send login information via email and instructions for setting password to client.
no = System will not send login information via email and instructions for setting password to client.

Note: Only accepted if client_portal_access is on
referred_by_firstname String Referred by first name should be in string format.
referred_by_lastname String Referred by last name should be in string format.
referred_by_email Email Email should be in email format.

* - Mandatory parameter


2. Update Record (Lead/Client)


Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: updateRecord

XML Format:

https://app.creditrepaircloud.com/api/lead/updateRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

<crcloud>
  <lead>
    <id>ODY4</id>
    <type>Client</type>
    <firstname>Scott</firstname>
    <lastname>James</lastname>
    <middlename>G</middlename>
    <suffix>Mr</suffix>
    <email>test@test.com</email>
    <phone_home>9999999999</phone_home>
    <phone_work>9999999999</phone_work>
    <phone_mobile>9999999999</phone_mobile>
    <street_address>street address</street_address>
    <city>New York</city>
    <state>NY</state>
    <post_code>10007</post_code>
    <ssno>545665656</ssno>
    <birth_date>10/31/1983</birth_date>
    <memo>test</memo>
    <previous_mailing_address>test</previous_mailing_address>
    <previous_city>New York</previous_city>
    <previous_state>NY</previous_state>
    <previous_post_code>10007</previous_post_code>
    <client_assigned_to>team member1,team member2</client_assigned_to>
    <referred_by_firstname>Freddy</referred_by_firstname>
    <referred_by_lastname>Katz</referred_by_lastname>
    <referred_by_email>demo@demo.com</referred_by_email>
  </lead>
</crcloud>

Request Parameters

Parameter Data Type Description
apiauthkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData* String This is an XML string and the format should be in XML format.
id* String Encrypted alphanumeric string.
type* String

Client status type should be in string format as per below.

Client
Lead
Lead/Inactive
Inactive
Suspended

Note: To add your own custom status. pls login and go to https://app.creditrepaircloud.com/mycompany/clientstatus and Copy status name in xml
firstname* String First name should be in string format.
lastname* String Last name should be in string format.
middlename String Middle name should be in string format.
suffix String Suffix should be in string format.
email Email Email should be in email format.
phone_home Integer Home Phone should be in 10 digit number format.
phone_work Integer Work Phone should be in 10 digit number format.
phone_mobile Integer Mobile Phone format should be in (999) 999-9999
street_address String Street Address should be in string format.
city String City should be in string format.
state String State should be in string format.
post_code Integer Post code should be in number format.
ssno Integer Social Security no.should be in 9 digit number format.
birth_date Date Birth date should be in in mm/dd/yyyy format.
memo String Memo should be in string format.
previous_mailing_address String Previous mailing address should be in string format. Previous mailing address (only if at current mailing address for less than 2 years)
previous_city String Previous City should be in string format.
previous_state String Previous State should be in string format.
previous_post_code Integer Previous post code should be in number format.
client_assigned_to String Name of team members with comma separator for assing team members to client.
Note: Pls login and go to https://app.creditrepaircloud.com/mycompany/team and Copy team member name in xml
referred_by_firstname String Referred by first name should be in string format.
referred_by_lastname String Referred by last name should be in string format.
referred_by_email Email Email should be in email format.

* - Mandatory parameter


3. Delete Record (Lead/Client)


Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: deleteRecord

XML Format:

https://app.creditrepaircloud.com/api/lead/deleteRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

<crcloud>
  <client>
  <id>MQ==</id>
  </client>
</crcloud>

Request Parameters

Parameter Data Type Description
apiauthkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData* String This is an XML string and the format should be in XML format.
id* String Encrypted alphanumeric string.

* - Mandatory parameter


4. View Record (Lead/Client)


Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: viewRecord

XML Format:

https://app.creditrepaircloud.com/api/lead/viewRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

<crcloud>
  <client>
  <id>MQ==</id>
  </client>
</crcloud>

Request Parameters

Parameter Data Type Description
apiauthkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData* String This is an XML string and the format should be in XML format.
id* String Encrypted alphanumeric string.

* - Mandatory parameter


1. Insert Record (Affiliate)


Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: insertRecord

XML Format:

https://app.creditrepaircloud.com/api/affiliate/insertRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

<crcloud>
  <affiliate>
    <type>Active</type>
    <firstname>Jonny</firstname>
    <lastname>Appleseed</lastname>
    <gender>Male</gender>
    <company>TEST ABC</company>
    <company_url>https://www.testabc.com</company_url>
    <email>test1@test1.com</email>
    <phone>5555555555</phone>
    <phone_ext>123</phone_ext>
    <alternate_phone>6666666666</alternate_phone>
    <fax>7777777777</fax>
    <mailing_address>street address</mailing_address>
    <city>New York</city>
    <state>NY</state>
    <post_code>10007</post_code>
    <internal_note>Internal test note</internal_note>
    <affiliate_portal_access>on</affiliate_portal_access>
    <affiliate_userid>test1@test1.com</affiliate_userid>
    <send_setup_password_info_via_email>yes</send_setup_password_info_via_email>
  </affiliate>
</crcloud>

Request Parameters

Parameter Data Type Description
apiauthkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData* String This is an XML string and the format should be in XML format.
type* String

Affiliate status type should be in string format as per below.

Active
Inactive
Pending
firstname* String First name should be in string format.
lastname* String Last name should be in string format.
gender* String Gender should be Male or Female.
company String Company name should be in string format.
company_url String Company URL should be in url format.
email* Email Email should be in email format.
phone* Integer Phone should be in 10 digit number format.
phone_ext Integer Phone extension should be upto 10 digit number format.
alternate_phone Integer Alternate phone should be in 10 digit number format.
mailing_address String Street Address should be in string format.
city String City should be in string format.
state String State should be in string format.
post_code Integer Post code should be in number format.
internal_note String Internal note should be in string format.
affiliate_portal_access on or off Portal Access for affiliate. Values should be on or off
https://secureclientaccess.com
on = Affiliate can access portal
off = Affiliate can not access portal
affiliate_userid Email Userid same as email
Note: Only accepted if affiliate_portal_access is on
send_setup_password_info_via_email yes or no yes = System will send login information via email and instructions for setting password to affiliate.
no = System will not send login information via email and instructions for setting password to affiliate.

Note: Only accepted if affiliate_portal_access is on

* - Mandatory parameter


2. Update Record (Affiliate)


Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: updateRecord

XML Format:

https://app.creditrepaircloud.com/api/affiliate/updateRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

<crcloud>
  <affiliate>
    <id>ODY4</id>
    <type>Active</type>
    <firstname>Jonny</firstname>
    <lastname>Appleseed</lastname>
    <gender>Male</gender>
    <company>TEST ABC</company>
    <company_url>https://www.testabc.com</company_url>
    <email>test1@test1.com</email>
    <phone>5555555555</phone>
    <phone_ext>123</phone_ext>
    <alternate_phone>6666666666</alternate_phone>
    <fax>7777777777</fax>
    <mailing_address>street address</mailing_address>
    <city>New York</city>
    <state>NY</state>
    <post_code>10007</post_code>
    <internal_note>Internal test note</internal_note>
  </affiliate>
</crcloud>

Request Parameters

Parameter Data Type Description
apiauthkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData* String This is an XML string and the format should be in XML format.
id* String Encrypted alphanumeric string.
type* String

Affiliate status type should be in string format as per below.

Active
Inactive
Pending
firstname* String First name should be in string format.
lastname* String Last name should be in string format.
gender* String Gender should be Male or Female.
company String Company name should be in string format.
company_url String Company URL should be in url format.
email* Email Email should be in email format.
phone* Integer Phone should be in 10 digit number format.
phone_ext Integer Phone extension should be upto 10 digit number format.
alternate_phone Integer Alternate phone should be in 10 digit number format.
mailing_address String Street Address should be in string format.
city String City should be in string format.
state String State should be in string format.
post_code Integer Post code should be in number format.
internal_note String Internal note should be in string format.

* - Mandatory parameter


3. Delete Record (Affiliate)


Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: deleteRecord

XML Format:

https://app.creditrepaircloud.com/api/affiliate/deleteRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

<crcloud>
  <affiliate>
  <id>MQ==</id>
  </affiliate>
</crcloud>

Request Parameters

Parameter Data Type Description
apiauthkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData* String This is an XML string and the format should be in XML format.
id* String Encrypted alphanumeric string.

* - Mandatory parameter


4. View Record (Affiliate)


Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: viewRecord

XML Format:

https://app.creditrepaircloud.com/api/affiliate/viewRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

<crcloud>
  <affiliate>
  <id>MQ==</id>
  </affiliate>
</crcloud>

Request Parameters

Parameter Data Type Description
apiauthkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey* String Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData* String This is an XML string and the format should be in XML format.
id* String Encrypted alphanumeric string.

* - Mandatory parameter


Abbreviation:US State:
ALAlabama
AKAlaska
ASAmerican Samoa
AZArizona
ARArkansas
CACalifornia
COColorado
CTConnecticut
DEDelaware
DCDistrict of Columbia
FLFlorida
GAGeorgia
GUGuam
HIHawaii
IDIdaho
ILIllinois
INIndiana
IAIowa
KSKansas
KYKentucky
LALouisiana
MEMaine
MDMaryland
MAMassachusetts
MIMichigan
MNMinnesota
MSMississippi
MOMissouri
MTMontana
NENebraska
NVNevada
NHNew Hampshire
NJNew Jersey
NMNew Mexico
NYNew York
NCNorth Carolina
NDNorth Dakota
MPNorthern Mariana Islands
OHOhio
OKOklahoma
OROregon
PAPennsylvania
PRPuerto Rico
RIRhode Island
SCSouth Carolina
SDSouth Dakota
TNTennessee
TXTexas
UMUnited States Minor Outlying Islands
UTUtah
VTVermont
VIVirgin Islands, U.S.
VAVirginia
WAWashington
WVWest Virginia
WIWisconsin
WYWyoming
 

Get started in only 60 seconds

Start, run and grow a lucrative credit repair business. 30 day free trial.


TRY IT FOR FREE
Start using Credit Repair Cloud today

In 2002, we created the world's first Credit Repair Software.
Our tools have helped millions of people to increase their credit scores.