Authentication and environments

Base URLs for the USA platform (when interacting with YouLends APIs)

When interacting with our USA specific endpoints, please use the below URLs.

Environment	Base URL
USA (production)	`https://youlendapi.us`
USA (staging)	`https://uspartners.staging-youlendapi.com`

Authentication URLs (to request an access token)

📘
Good to know
Please visit our Authentication guide for more information regarding authenticating in USA

Environment	URL
USA (production)	`https://youlend-us.us.auth0.com/oauth/token`
USA (staging)	`https://youlend-stag.eu.auth0.com/oauth/token`

Onboarding APIs

This section focuses on all APIs that partners can interact with when onboarding a merchant.

Parameter callouts

Parameters	Description
`signupClientIp`	This is a mandatory param within the Create a lead API request
`employerIdentificationNumber`	This is a mandatory param within the Create a lead API request (this is not required for `SoleTrader` businesses)
`companyType`	`SoleTrader` `Partnership` `LLC` `BusinessCorporation`
`registeredAddress`	When submitting an Address, the region param is mandatory and must correspond to a valid State (eg. `New York`), or a valid ANSI 2 letter State code (eg. `NY`)
`typeOfPerson`	In the Update significant persons endpoint, at least one of `ExecutiveOfficer` or `ExecutiveOfficerAndOwner` must be on a lead in order to submit
`mobilePhoneNumber`	The format for this parameter is: `+1xxxxxxxxx`
`countryISOCode`	`USA`
`loanCurrencyISOCode`	`USD`

Example Submit Lead Request

{
  "thirdPartyCustomerId": "16d81dac",
  "confirmedCreditSearch": true,
  "countryISOCode": "USA",
  "loanCurrencyISOCode": "USD",
  "keyContactName": "James Johnson",
  "companyType": "businessCorporation",
  "companyName": "Test Company",
  "signupClientIp": "9.255.255.255",
  "registeredAddress": {
    "line1": "5 Happy Road",
    "city": "New York",
    "region": "New York",
    "areaCode": "10007",
    "country": "USA"
  },
  "contactPhoneNumber": "+12124567890",
  "contactEmailAddress": "[email protected]",
  "employerIdentificationNumber": "12-3456789",
  "preferredLanguageCode": "EN_US",
  "confirmedCreditSearch": true
}

📘
Good to know
In the US we recommend the following repayment method, Sales Based Repayments (partner managed, bulk payment)

Offers and Signing API

For some states in the US, there will be an additional document provided in the GET documents to sign for a lead endpoint. This is the additionalloandocument document type, and will be provided in addition to the loanDocument.

States where this doc is present

State	Code
California	ca
New York	ny
Utah	ut
Florida	fl
Georgia	ga
Virginia	va
Kansas	ks
Connecticut	ct
Louisiana	la
Missouri	mo