Amount API

Endpoint

All requests will be made to the following endpoint:

https://api.amount.com

Note that this endpoint is different depending on environment.

Requesting a missing path will respond with a status of 404 NOT FOUND with the following body:

{ "message": "Not Found" }

Authentication

Please request an API Token and send it with all requests in the following header:

Authorization: Bearer TOKEN

If the token is missing or incorrect, the response will have a status code of 401 UNAUTHORIZED with the following body:

{ "message": "Unauthorized" }

Heartbeat

Always returns success

GET /heartbeat

Request

Empty request

Response

`200 Success`

The response body is of content type application/json.

{ "success": true }

Parameter	Description	Example
`success`	Always true	`true`

Example

curl -H "Authorization: Bearer TOKEN" https://api.amount.com/heartbeat

{"success":true}

Fraud Score

Returns a fraud score for an applicant

POST /v1/verify/fraud-score

Request

The request body should be of content type application/json.

{
  "identity": {
    "first_name": "string",
    "last_name": "string",
    "ssn": "string",
    "date_of_birth": "string"
  },
  "address": {
    "address_1": "string",
    "address_2": "string",
    "city":      "string",
    "state":     "string",
    "zip_code":  "string"
  },
  "contact": {
    "email": "string",
    "phone": "string"
  },
  "ip": {
    "ip_address": "string"
  },
  "income": {
    "amount": "string",
    "type": "string"
  },
  "event": {
    "id": "string",
    "type": "string",
    "product_type": "string"
  }
}

Parameter	Name	Required	Format	Example
`identity.first_name`	First Name	Yes	Non empty string, max length: 16	`"Robert"`
`identity.last_name`	Last Name	Yes	Non empty string, max length: 24	`"Smith"`
`identity.ssn`	Social Security Number	Yes	9 digits without dashes	`"123456789"`
`identity.date_of_birth`	Date of Birth	Yes	YYYY-MM-DD	`"2019-04-30"`
`address.address_1`	Address (Line 1)	Yes	Non empty string	`"123 Michigan Ave"`
`address.address_2`	Address (Line 2)	No	If passed in, non empty string	`"Apt. 123"`
`address.city`	City	Yes	Non empty string, max length: 22	`"Chicago"`
`identity.state`	State	Yes	2 uppercase characters (50 states and DC)	`"IL"`
`identity.zip_code`	Zip Code	Yes	5 digits	`"60654"`
`contact.email`	Email	Yes	Email, max length: 130	`"[email protected]"`
`contact.phone`	Phone	Yes	10 digits without other symbols	`"3125551234"`
`ip.ip_address`	IP Address	No		`"198.51.100.42"`
`income.amount`	Income	No	String without dollar sign or cents	`"1000"`
`income.type`	Income Type	No	One of: `"monthly_gross_income"` `"monthly_net_income"` `"yearly_gross_income"` `"yearly_net_income"`	`"monthly_gross_income"`
`event.id`	Event ID	Yes	Non empty string: user defined ID to track the event	`"ABC1234"`
`event.type`	Event Type	Yes	One of: `"account_opening"` `"information_update"` `"payment"`	`"account_opening"`
`event.product_type`	Product Type	Yes	One of: `"credit_card"` `"deposit_account"` `"unsecured_installment_loan"`	`"unsecured_installment_loan"`

Response

`200 Success`

The response body is of content type application/json.

{
  "session_id": "string",
  "score": number
}

Parameter	Description	Example
`session_id`	The session UUID, always returned	`"bc154584-5e50-4629-b137-6505fb67e49d"`
`score`	The fraud score if no errors	`0.264880258925984`

`400 Bad Request`

The response body is empty or of content type application/json.

{
  "session_id": "string",
  "message": [
    "string",
    "string",
    "string"
  ]
}

Parameter	Description	Example
`session_id`	The session UUID, always returned	`"bc154584-5e50-4629-b137-6505fb67e49d"`
`message`	One or more error messages if errors (see below)	`["error 1", "error 2"]`

Error Messages

Category	Error Message Examples	Description
Invalid request	Empty response body `"request: [\"Missing Request\"]"`	Verify that you are sending a request body that can be parsed by JSON
Validation	`"identity: {:first_name=>[\"must be filled\"]}"` `"address: {:state=>[\"state is not valid\"]}"` `"contact: {:email=>[\"must be of form [email protected]\"]}"`	Verify that you are sending all fields with the correct formats

`500 Internal server Error`

Our monitoring will alert us if this happens. Please contact support for more information.

Example

curl -H "Authorization: Bearer TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"identity":{"first_name":"Robert","last_name":"Smith","date_of_birth":"2019-04-30","ssn":"123456789"},
          "address":{"address_1":"123 Michigan Ave","city":"Chicago","state":"IL","zip_code":"60654"},
          "contact":{"email":"[email protected]","phone":"3125551234"},
          "event":{"id":"ABC1234","type":"account_opening","product_type":"unsecured_installment_loan"}}' \
     https://api.amount.com/v1/verify/fraud-score

{"session_id":"c242d80b-dc5b-4d5a-b931-dd8ac236283d","score":0.5}