SellSecure Review API

The SellSecure Review API is organized around REST.

Our API uses HTTP response code to indicate API errors. The API use built-in HTTP features, like HTTP authentication and HTTP verbs which are understood by the common of HTTP clients.

The API uses JSON as request and response body.

The authentication

The SellSecure Review API uses HTTP Basic authentication. All requests should be authenticated.

To authenticate with HTTP Basic, you just need to generate a token:

base64_encode("john.doe@example.tld:thepassword")

Once the token created, just add a HTTP header as following:

Authorization: Basic <the generated token in base64>

The request will be authenticated as John Doe.

Users

Me

The « Me » resource represents the currently authenticated user

GET https://api.review.sellsecure.com/me
Responses200403
Headers
Content-Type: application/json
Body
{
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "email": "john.doe@example.tld",
  "roles": [],
  "first_name": "John",
  "last_name": "Doe",
  "language": "fr",
  "company": {
    "id": "12345678-90ab-cdef-1234-567890abcdef"
  },
  "balance": {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "tokens": 42
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The user ID"
    },
    "email": {
      "type": "string",
      "description": "The account email address"
    },
    "roles": {
      "description": "The account rights"
    },
    "first_name": {
      "type": "string",
      "description": "The user first name"
    },
    "last_name": {
      "type": "string",
      "description": "The user last name"
    },
    "language": {
      "type": "string",
      "description": "The account language"
    },
    "company": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The company ID"
        }
      },
      "description": "The user company"
    },
    "balance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The balance ID"
        },
        "tokens": {
          "type": "number",
          "description": "The amount of tokens left"
        }
      },
      "description": "The user/company balance"
    }
  }
}
This response has no content.

Retrieve the current user
GET/me


PUT https://api.review.sellsecure.com/me
Requestswith body
Body
{
  "plain_password": "a password",
  "first_name": "John",
  "last_name": "Doe",
  "language": "fr"
}
Schema
{
  "type": "object",
  "properties": {
    "plain_password": {
      "type": "string",
      "description": "The account password"
    },
    "first_name": {
      "type": "string",
      "description": "The user first name"
    },
    "last_name": {
      "type": "string",
      "description": "The user last name"
    },
    "language": {
      "type": "string",
      "description": "The account language"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200400403
Headers
Content-Type: application/json
Body
{
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "email": "john.doe@example.tld",
  "roles": [],
  "first_name": "John",
  "last_name": "Doe",
  "language": "fr",
  "company": {
    "id": "12345678-90ab-cdef-1234-567890abcdef"
  },
  "balance": {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "tokens": 42
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The user ID"
    },
    "email": {
      "type": "string",
      "description": "The account email address"
    },
    "roles": {
      "description": "The account rights"
    },
    "first_name": {
      "type": "string",
      "description": "The user first name"
    },
    "last_name": {
      "type": "string",
      "description": "The user last name"
    },
    "language": {
      "type": "string",
      "description": "The account language"
    },
    "company": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The company ID"
        }
      },
      "description": "The user company"
    },
    "balance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The balance ID"
        },
        "tokens": {
          "type": "number",
          "description": "The amount of tokens left"
        }
      },
      "description": "The user/company balance"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 400,
  "message": "Validation Failed",
  "errors": {}
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "The error code"
    },
    "message": {
      "type": "string",
      "description": "The error message"
    },
    "errors": {
      "type": "object",
      "properties": {},
      "description": "The error details"
    }
  }
}
This response has no content.

Edit the current user profile
PUT/me


User

An user represents a SellSecure Review account.

GET https://api.review.sellsecure.com/users?limit=25&offset=0
Responses200
Headers
Content-Type: application/json
Content-Range: 0-49/12345
Body
[
  {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "email": "john.doe@example.tld",
    "roles": [],
    "first_name": "John",
    "last_name": "Doe",
    "language": "fr",
    "company": {
      "id": "12345678-90ab-cdef-1234-567890abcdef"
    },
    "balance": {
      "id": "12345678-90ab-cdef-1234-567890abcdef",
      "tokens": 42
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Get a list of users
GET/users{?limit,offset}

URI Parameters
HideShow
limit
integer (optional) Example: 25

The maximum number of reviews to return, up to 50

offset
integer (optional) Example: 0

The number of reviews to start listing


POST https://api.review.sellsecure.com/users
Requestswith body
Body
{
  "email": "john.doe@example.tld",
  "plain_password": "a password",
  "first_name": "John",
  "last_name": "Doe",
  "language": "fr",
  "roles": []
}
Schema
{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The account email address"
    },
    "plain_password": {
      "type": "string",
      "description": "The account password"
    },
    "first_name": {
      "type": "string",
      "description": "The user first name"
    },
    "last_name": {
      "type": "string",
      "description": "The user last name"
    },
    "language": {
      "type": "string",
      "description": "The account language"
    },
    "roles": {
      "type": "array",
      "description": "The account rights"
    }
  },
  "required": [
    "email",
    "roles"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200400403
Headers
Content-Type: application/json
Body
{
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "email": "john.doe@example.tld",
  "roles": [],
  "first_name": "John",
  "last_name": "Doe",
  "language": "fr",
  "company": {
    "id": "12345678-90ab-cdef-1234-567890abcdef"
  },
  "balance": {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "tokens": 42
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The user ID"
    },
    "email": {
      "type": "string",
      "description": "The account email address"
    },
    "roles": {
      "description": "The account rights"
    },
    "first_name": {
      "type": "string",
      "description": "The user first name"
    },
    "last_name": {
      "type": "string",
      "description": "The user last name"
    },
    "language": {
      "type": "string",
      "description": "The account language"
    },
    "company": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The company ID"
        }
      },
      "description": "The user company"
    },
    "balance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The balance ID"
        },
        "tokens": {
          "type": "number",
          "description": "The amount of tokens left"
        }
      },
      "description": "The user/company balance"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 400,
  "message": "Validation Failed",
  "errors": {}
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "The error code"
    },
    "message": {
      "type": "string",
      "description": "The error message"
    },
    "errors": {
      "type": "object",
      "properties": {},
      "description": "The error details"
    }
  }
}
This response has no content.

Create an user
POST/users


GET https://api.review.sellsecure.com/user/12345678-90ab-cdef-1234-567890abcdef
Responses200403404
Headers
Content-Type: application/json
Body
{
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "email": "john.doe@example.tld",
  "roles": [],
  "first_name": "John",
  "last_name": "Doe",
  "language": "fr",
  "company": {
    "id": "12345678-90ab-cdef-1234-567890abcdef"
  },
  "balance": {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "tokens": 42
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The user ID"
    },
    "email": {
      "type": "string",
      "description": "The account email address"
    },
    "roles": {
      "description": "The account rights"
    },
    "first_name": {
      "type": "string",
      "description": "The user first name"
    },
    "last_name": {
      "type": "string",
      "description": "The user last name"
    },
    "language": {
      "type": "string",
      "description": "The account language"
    },
    "company": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The company ID"
        }
      },
      "description": "The user company"
    },
    "balance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The balance ID"
        },
        "tokens": {
          "type": "number",
          "description": "The amount of tokens left"
        }
      },
      "description": "The user/company balance"
    }
  }
}
This response has no content.
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 404,
    "message": "Not Found"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "The error code"
        },
        "message": {
          "type": "string",
          "description": "The error message"
        }
      }
    }
  }
}

Retrieve an user
GET/user/{id}

URI Parameters
HideShow
id
string (required) Example: 12345678-90ab-cdef-1234-567890abcdef

The user ID


PUT https://api.review.sellsecure.com/users/12345678-90ab-cdef-1234-567890abcdef
Requestswith body
Body
{
  "plain_password": "a password",
  "first_name": "John",
  "last_name": "Doe",
  "language": "fr",
  "roles": []
}
Schema
{
  "type": "object",
  "properties": {
    "plain_password": {
      "type": "string",
      "description": "The account password"
    },
    "first_name": {
      "type": "string",
      "description": "The user first name"
    },
    "last_name": {
      "type": "string",
      "description": "The user last name"
    },
    "language": {
      "type": "string",
      "description": "The account language"
    },
    "roles": {
      "type": "array",
      "description": "The account rights"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200400403
Headers
Content-Type: application/json
Body
{
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "email": "john.doe@example.tld",
  "roles": [],
  "first_name": "John",
  "last_name": "Doe",
  "language": "fr",
  "company": {
    "id": "12345678-90ab-cdef-1234-567890abcdef"
  },
  "balance": {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "tokens": 42
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The user ID"
    },
    "email": {
      "type": "string",
      "description": "The account email address"
    },
    "roles": {
      "description": "The account rights"
    },
    "first_name": {
      "type": "string",
      "description": "The user first name"
    },
    "last_name": {
      "type": "string",
      "description": "The user last name"
    },
    "language": {
      "type": "string",
      "description": "The account language"
    },
    "company": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The company ID"
        }
      },
      "description": "The user company"
    },
    "balance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The balance ID"
        },
        "tokens": {
          "type": "number",
          "description": "The amount of tokens left"
        }
      },
      "description": "The user/company balance"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 400,
  "message": "Validation Failed",
  "errors": {}
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "The error code"
    },
    "message": {
      "type": "string",
      "description": "The error message"
    },
    "errors": {
      "type": "object",
      "properties": {},
      "description": "The error details"
    }
  }
}
This response has no content.

Edit an user
PUT/users/{id}

URI Parameters
HideShow
id
string (required) Example: 12345678-90ab-cdef-1234-567890abcdef

The user ID


Reviews

A Review is the base of the SellSecure Review application.

Review

GET https://api.review.sellsecure.com/reviews?limit=25&offset=0
Responses200403
Headers
Content-Type: application/json
Content-Range: 0-49/12345
Body
[
  {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "created_by": {
      "id": "12345678-90ab-cdef-1234-567890abcdef",
      "email": "john.doe@example.tld",
      "roles": [],
      "first_name": "John",
      "last_name": "Doe"
    },
    "created_at": "2016-11-04T17:23:36+0100",
    "analyses": [],
    "reliability": 42.21
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
This response has no content.

Get a list of reviews
GET/reviews{?limit,offset}

URI Parameters
HideShow
limit
integer (optional) Example: 25

The maximum number of reviews to return, up to 50

offset
integer (optional) Example: 0

The number of reviews to start listing


POST https://api.review.sellsecure.com/reviews
Requestswith body
Body
{
  "bin_numbers": [
    {
      "number": 123456
    }
  ],
  "email_addresses": [
    {
      "address": "john.doe@example.tld"
    }
  ],
  "identities": [
    {
      "first_name": "John",
      "last_name": "Doe"
    }
  ],
  "ip_addresses": [
    {
      "address": "255.255.255.255"
    }
  ],
  "phone_numbers": [
    {
      "number": "+33612345678"
    }
  ],
  "postal_addresses": [
    {
      "type": 1,
      "house": "30",
      "route": "Avenue de Flandres",
      "city": "Croix",
      "state": "Nord Pas De Calais",
      "postal_code": "59170",
      "country_code": "FR"
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "bin_numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "number": {
            "type": "number",
            "description": "The credit card BIN number"
          }
        },
        "required": [
          "number"
        ]
      }
    },
    "email_addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "description": "The email address"
          }
        },
        "required": [
          "address"
        ]
      }
    },
    "identities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "description": "The first name"
          },
          "last_name": {
            "type": "string",
            "description": "The last name"
          }
        },
        "required": [
          "first_name",
          "last_name"
        ]
      }
    },
    "ip_addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "description": "The IP address"
          }
        },
        "required": [
          "address"
        ]
      }
    },
    "phone_numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "number": {
            "type": "string",
            "description": "The international format phone number"
          }
        },
        "required": [
          "number"
        ]
      }
    },
    "postal_addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "number",
            "description": "The postal address type (See PostalAddressType constants)"
          },
          "house": {
            "type": "string",
            "description": "The house number"
          },
          "route": {
            "type": "string",
            "description": "The route"
          },
          "city": {
            "type": "string",
            "description": "The city"
          },
          "state": {
            "type": "string",
            "description": "The state"
          },
          "postal_code": {
            "type": "string",
            "description": "The postal code"
          },
          "country_code": {
            "type": "string",
            "description": "The country code"
          }
        },
        "required": [
          "postal_code",
          "country_code"
        ]
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200403400
Headers
Content-Type: application/json
Body
{
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "created_by": {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "email": "john.doe@example.tld",
    "roles": [],
    "first_name": "John",
    "last_name": "Doe"
  },
  "created_at": "2016-11-04T17:23:36+0100",
  "analyses": [
    {
      "name": "email_address_blacklisted",
      "label": "The email address is blacklisted",
      "color": "#ff2222"
    }
  ],
  "reliability": 42.21,
  "email_addresses": [
    {
      "crawl": {
        "accounts": [
          {
            "profile_photo_url": "https://www.example.com/profile.png"
          }
        ]
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The review ID"
    },
    "created_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The user ID"
        },
        "email": {
          "type": "string",
          "description": "The account email address"
        },
        "roles": {
          "description": "The account rights"
        },
        "first_name": {
          "type": "string",
          "description": "The user first name"
        },
        "last_name": {
          "type": "string",
          "description": "The user last name"
        }
      },
      "description": "The owner of the review"
    },
    "created_at": {
      "type": "string",
      "description": "The creation date of the review"
    },
    "email_addresses": {
      "type": "array"
    },
    "analyses": {
      "type": "array"
    },
    "reliability": {
      "type": "number",
      "description": "The reliability of the Review (based on your/our rules)"
    }
  }
}
This response has no content.
Headers
Content-Type: application/json
Body
{
  "code": 400,
  "message": "Validation Failed",
  "errors": {}
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "The error code"
    },
    "message": {
      "type": "string",
      "description": "The error message"
    },
    "errors": {
      "type": "object",
      "properties": {},
      "description": "The error details"
    }
  }
}

Create a review
POST/reviews


GET https://api.review.sellsecure.com/reviews/12345678-90ab-cdef-1234-567890abcdef
Responses200403404
Headers
Content-Type: application/json
Body
{
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "created_by": {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "email": "john.doe@example.tld",
    "roles": [],
    "first_name": "John",
    "last_name": "Doe"
  },
  "created_at": "2016-11-04T17:23:36+0100",
  "analyses": [
    {
      "name": "email_address_blacklisted",
      "label": "The email address is blacklisted",
      "color": "#ff2222"
    }
  ],
  "reliability": 42.21,
  "email_addresses": [
    {
      "crawl": {
        "accounts": [
          {
            "profile_photo_url": "https://www.example.com/profile.png"
          }
        ]
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The review ID"
    },
    "created_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The user ID"
        },
        "email": {
          "type": "string",
          "description": "The account email address"
        },
        "roles": {
          "description": "The account rights"
        },
        "first_name": {
          "type": "string",
          "description": "The user first name"
        },
        "last_name": {
          "type": "string",
          "description": "The user last name"
        }
      },
      "description": "The owner of the review"
    },
    "created_at": {
      "type": "string",
      "description": "The creation date of the review"
    },
    "email_addresses": {
      "type": "array"
    },
    "analyses": {
      "type": "array"
    },
    "reliability": {
      "type": "number",
      "description": "The reliability of the Review (based on your/our rules)"
    }
  }
}
This response has no content.
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 404,
    "message": "Not Found"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "The error code"
        },
        "message": {
          "type": "string",
          "description": "The error message"
        }
      }
    }
  }
}

Retrieve a review
GET/reviews/{id}

URI Parameters
HideShow
id
string (required) Example: 12345678-90ab-cdef-1234-567890abcdef

The review ID


ReviewFeedback

GET https://api.review.sellsecure.com/reviews/12345678-90ab-cdef-1234-567890abcdef/feedback
Responses200204403404
Headers
Content-Type: aplication/json
Body
{
  "status": "good",
  "comment": "Hello World"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The status of the feedback (See ReviewFeedback status constants)"
    },
    "comment": {
      "type": "string",
      "description": "The comment of the feedback"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
This response has no content.
This response has no content.
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 404,
    "message": "Not Found"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "The error code"
        },
        "message": {
          "type": "string",
          "description": "The error message"
        }
      }
    }
  }
}

Retrieve a review feedback
GET/reviews/{id}/feedback

URI Parameters
HideShow
id
string (required) Example: 12345678-90ab-cdef-1234-567890abcdef

The review ID


PUT https://api.review.sellsecure.com/reviews/12345678-90ab-cdef-1234-567890abcdef/feedback
Requestswith body
Body
{
  "status": "good",
  "comment": "Hello World"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The status of the feedback (See ReviewFeedback status constants)"
    },
    "comment": {
      "type": "string",
      "description": "The comment of the feedback"
    }
  },
  "required": [
    "status"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200403404
Headers
Content-Type: application/json
This response has no content.
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 404,
    "message": "Not Found"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "The error code"
        },
        "message": {
          "type": "string",
          "description": "The error message"
        }
      }
    }
  }
}

Edit a review feedback
PUT/reviews/{id}/feedback

URI Parameters
HideShow
id
string (required) Example: 12345678-90ab-cdef-1234-567890abcdef

The review ID


Companies

A company is an organization-like, users can be grouped into a company and do actions for this company.

Retrieve a company

GET https://api.review.sellsecure.com/companies/12345678-90ab-cdef-1234-567890abcdef
Responses200403404
Headers
Content-Type: application/json
Body
{
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "name": "Example Inc.",
  "users": [
    {
      "id": "12345678-90ab-cdef-1234-567890abcdef",
      "email": "john.doe@example.tld",
      "roles": [],
      "first_name": "John",
      "last_name": "Doe"
    }
  ],
  "balance": {
    "id": "12345678-90ab-cdef-1234-567890abcdef"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The company ID"
    },
    "name": {
      "type": "string",
      "description": "The company name"
    },
    "users": {
      "type": "array"
    },
    "balance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The balance ID"
        }
      }
    }
  }
}
This response has no content.
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 404,
    "message": "Not Found"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "The error code"
        },
        "message": {
          "type": "string",
          "description": "The error message"
        }
      }
    }
  }
}

Retrieve a company
GET/companies/{id}

URI Parameters
HideShow
id
string (required) Example: 12345678-90ab-cdef-1234-567890abcdef

The company ID


Balances

The balance is where the amounts of tokens left is stored.

Retrieve a balance

GET https://api.review.sellsecure.com/balance/12345678-90ab-cdef-1234-567890abcdef
Responses200403404
Headers
Content-Type: application/json
Body
{
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "tokens": 42
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The balance ID"
    },
    "tokens": {
      "type": "number",
      "description": "The amount of tokens left"
    }
  }
}
This response has no content.
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 404,
    "message": "Not Found"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "The error code"
        },
        "message": {
          "type": "string",
          "description": "The error message"
        }
      }
    }
  }
}

Retrieve a balance
GET/balance/{id}

Allow to get the balance of the current user.

URI Parameters
HideShow
id
string (required) Example: 12345678-90ab-cdef-1234-567890abcdef

The balance ID


Constants

PostalAddressType

Value Description
0 An unknown postal address.
1 A shipping postal address address.
2 A billing postal address.

Existence

Value Description
0 The existence is not defined or not known.
1 It exists.
2 It not exists.

ReviewFeedback statuses

Value Description
good The profile is good.
doubt The profile MAY be bad, but just in case.
bad The profile is totally bad.

AccountType

Value Description
0 The account type is not defined.
1 Social network account.
2 Manufacturer account.
3 E-commerce account.
4 Financial account.
5 Communication account.

CarrierType

Value Description
0 The carrier is not defined.
1 The carrier is a mobile network.
2 The carrier is a land line network.
3
4 The carrier is a virtual network.

Phone Number Portability

Value Description
0 The portability is not defined.
1 The phone number has been ported.
2 The phone number is not ported.

Phone Number Reachable

Value Description
0 The reachable is not defined.
1 The phone number is reachable.
2 The phone number is not reachable.
3 The phone number is on answering machine.

Postal Address Typology

Value Description
A1 Wealthy families, Houses in trendy neighborhoods
A2 Wealthy families, Trendy neighborhoods
A3 Wealthy families, Houses in trendy suburbs
A4 Wealthy families, Large houses
B1 Urban couple / families, Young workers and retirees
B2 Urban couple / families, Student center, downtown, ancient small flats
B3 Urban couple / families, Urban seniors, ancient middle-sized flats, average revenue
B4 Urban couple / families, Rented flats in blocks, modest revenue
C1 Wealthy young professionals, Crested parisian youth, small flats, students
C2 Wealthy young professionals, Urban youth, ancient middle-sized flats
D1 Young active families, Dynamic suburbs, recent flats
D2 Young active families, New complex, average revenue
D3 Young active families, Ancient large houses, average revenue
E1 Student lifestyle, Rented small flats
F1 Troubled urban youth, Flats in blocks, average revenue
F2 Troubled urban youth, Flats in blocks, mono-parental families
F3 Troubled urban youth, Conurbation blocks, very modest revenue
G1 Seniors facing precarity, Modest revenue
G2 Seniors facing precarity, Very modest revenue
H1 Countryside workers and retirees, Holiday destinations, mainly second homes
H2 Countryside workers and retirees, Singles in rural area, modest revenue
H3 Countryside workers and retirees, Rural active families, modest revenue
H4 Countryside workers and retirees, Rural couples, ancient individual houses
H5 Countryside workers and retirees, Retired craftsmen, retired shop-owners
H6 Countryside workers and retirees, Long established rural inhabitants, average revenue

Generated by aglio on 07 Apr 2017