Two Limits API (1.0)

Download OpenAPI specification:Download

Overview and usage

This API allows you to retrieve the credit limit of your buyers.

To be specific, you can lookup credit limit for your buyers using organization number or canonical ID which you can obtain via our Company API.

This API is not enabled by default. To request access, please contact us at integration@two.inc for more information.

Environments

Testing

https://api.sandbox.two.inc

Note: Read about our sandbox environment specific behaviour.

Production

https://api.two.inc

Limits

Retrieve company credit limit

Retrieve buyer company credit limit based on buyer country code and organization number.

SecurityX-Api-Key
Request
path Parameters
buyer_country_code
required
string

Buyer country code

buyer_organization_number
required
string

Buyer organization number

Responses
200

Credit limits

403

Access denied

404

Buyer company not found

default

Error response

get/limits/v1/company/{buyer_country_code}/{buyer_organization_number}
Request samples 
Response samples 
application/json
{
  • "decision": {
    },
  • "credit": {
    },
  • "recourse": null,
  • "buyer_company_name": "string",
  • "company_number": "string",
  • "country_code": "AT",
  • "currency": "NOK"
}
Retrieve company credit limit by canonical ID
Retrieve buyer company credit limit based on company canonical ID. This is a unique ID that represents a company on our system and can be obtained using our Company API.


SecurityX-Api-Key 
Request 
path Parameters
buyer_company_canonical_id
required
string
Buyer company canonical ID


 
Responses 
200
Credit limits


403
Access denied


404
Buyer company not found


default
Error response


get/limits/v1/company/{buyer_company_canonical_id}
Request samples 
Response samples 
application/json
{
  • "decision": {
    },
  • "credit": {
    },
  • "recourse": null,
  • "buyer_company_name": "string",
  • "company_number": "string",
  • "country_code": "AT",
  • "currency": "NOK"
}
Create a credit builder url for a buyer company.
Create buyer company credit builder url based on company canonical ID, and supply a return url for user to return to upon completion of credit builder. Canonical ID a unique ID that represents a company on our system and can be obtained using our Company API


SecurityX-Api-Key 
Request 
Request Body schema: application/json
canonical_id
required
string (Canonical Id) 
Unique canonical ID representing the company the credit builder url is for


 
Company Representative Email (string) or Company Representative Email (null) (Company Representative Email) 
 Default:  null
Email of the company representative, this allows us to contact the user on the outcome of their credit builder application if the data needs to be manually reviewed. This is optional and can be None.


 
return_url
required
string (Return Url) 
Url the user will be advised to return to after the credit builder process is completed


 
Responses 
201
Credit builder url response


403
Access denied


404
Buyer company not found


default
Error response


post/limits/v1/credit-builder/url
Request samples 
application/json
{
  • "canonical_id": "string",
  • "return_url": "string",
  • "company_representative_email": null
}
Response samples 
application/json
{
  • "redirect_url": "string",
  • "expires_at": "2019-08-24T14:15:22Z"
}