Authentication

As a start please obtain your client_id and client_secret from FriendlyScore API keys. All endpoints except the authorisation endpoint require authorisation using the access_token

Get an access token

POST

/oauth/v3/token

FriendlyScore uses access tokens to authenticate and authorise API requests.To obtain your access token, please ensure you have created a FriendlyScore user account. The access token, which is valid for a limited time, is provided using an authorisation header with structure Authorisation: Bearer access_token. Upon expiration, calls to the API with that token will return the error code 401 Unauthorised and a new access token has to be recreated by repeating the steps above.

Keep your credentials secret

Do not share your client_id and client_secret with anyone.

Parameters

ParameterData typeRequired?Description
client_idstringyesOAuth client_id
client_secretstringyesOAuth client_secret
grant_typestringyesPlease set the grant to "client_credentials"

Request example:

1 2 3 4 5 6 curl --location --request POST 'https://api.friendlyscore.com/oauth/v3/token' --data-raw '{ "client_id": "{client_id}", "client_secret": "{client_secret}", "grant_type": "client_credentials" }'

Response example:

1 2 3 4 5 6 { "access_token": "{YOUR_USER_ACCESS_TOKEN}", "expires_in": 3600, "token_type": "bearer", "scope": null }

Was this article helpful?

Friendly Score UK Ltd.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

Call us on +44 20 3709 6726

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 781963)