README.md in lenddo-1.0.1 vs README.md in lenddo-1.1.0
- old
+ new
@@ -28,11 +28,11 @@
Lenddo.configure do |config|
config.access_key = @access_key
config.secret_key = @secret_key
end
-Note: To get your `@access_key` and `@secret_key` go to https://partners.lenddo.com/api_key.
+Note: To get your `@access_key` and `@secret_key` go to https://dashboard.lenddo.com/client/api_key.
## Service Client
The `ServiceClient` allows the client to send extra information or retrieve the scoring, verification, and decision results from Lenddo. To use run `require 'lenddo/service_client'`
@@ -40,10 +40,16 @@
To retrieve the score you'll need the application ID and the partner script ID that you used to create the application.
Lenddo::ServiceClient.application_score(@application_id, @partnerscript_id)
+### Get Multiple scores
+
+Return an array of LenddoScore records for the supplied application id using models specifically tuned to the applicant pool of the partner associated with the current API user. LenddoScore is a measure of the expected creditworthiness of a Lenddo user. It ranges is from 0 (the highest risk) to 1000 (the lowest risk). Lenddo's scoring algorithms consider over 300 features per user when generating a score. These features are calculated from Lenddo's proprietary social graph as well as from any data specifically shared by the partner. In the event that a score cannot be correctly calculated, the LenddoScore will be returned as -1 along with an array of flag codes.
+
+ Lenddo::ServiceClient.application_multiple_scores(@application_id, @partnerscript_id)
+
### Get a Verification
To retrieve the verification you'll need the application ID and the partner script ID that you used to create the application.
Lenddo::ServiceClient.application_verification(@application_id, @partnerscript_id)
@@ -90,11 +96,11 @@
note: The key and secret are not your application key and secret. They're the values which are returned after a user successfully authenticates with the social network's OAuth.
OAuth secret - optional, leave null if not applicable. Some OAuth providers may return a secret when this is returned Lenddo will require the secret to using the token.
4. **token data** - This is the raw token as it was received from the provider in an Array format. This may include a **extra_data** key.
- Lenddo::WhiteLabelClient.partner_token(application_id, provider, oauth_key, oauth_secret, token_data)
+ `Lenddo::WhiteLabelClient.partner_token(application_id, provider, oauth_key, oauth_secret, token_data)`
#### Errors
* **BAD_REQUEST** *HTTP Status Code: 400* Request was malformed, or missing required data.
@@ -114,12 +120,16 @@
3. **profile ids** - This is an array of ID's composed from the results of the `Lenddo::WhiteLabelClient.partner_token` service call.
4. **verification** - This is an optional argument which will allow you to send probe data with the verification object.
- Lenddo::WhiteLabelClient.commit_partner_job(partnerscript_id, application_id, profile_ids, verification)
+ `Lenddo::WhiteLabelClient.commit_partner_job(partnerscript_id, application_id, profile_ids, verification)`
-#### Errors
+### Errors
+
+* **ACCEPTED** *HTTP Status Code: 202* Strictly speaking, not an error. This status code indicates that not enough data has been gathered to compute the applicant's scores, but data will be available in the future.
+
+* **NOT_FOUND** *HTTP Status Code: 404* The specified application_id was not found
* **BAD_REQUEST** *HTTP Status Code: 400* Request was malformed, or missing required data.
* **PARTNER_CLIENT_ALREADY_PROCESSED** *HTTP Status Code 400* This occurs when the specified APPLICATION_ID has already been used.
\ No newline at end of file