Get Buyer Details

get https://api-sandbox.sprinque.com/api/v1/buyers/{buyer_id}

The Get Buyers details API is used by the Merchant to get a detailed buyer data.

Recipes

🦉

Buyer Onboarding

Open Recipe

Response

Response body

object

buyer_id

string

required

Unique id of the business generated by sprinque during business registration.

business_name

string

required

Name of the business as registered with the government.

merchant_buyer_id

string

required

External Reference ID of the buyer generated by the Marketplace or Merchant.

legal_form

string | null

Type of business ownership, for example - 'Sole Proprietorship'

registration_number

string | null

Unique registration number or chamber of commerce number, of the business being onboarded, as mentioned with the country’s government.

steuernummer

string | null

Special tax number for small businesses. Applicable for Germany only.

registration_date

date | null

Date the business was registered with the government. Format in YYYY-MM-DD

address

object

required

address_line1

string

required

Line 1 of the address of the business.

address_line2

string | null

Line 2 of the address of the business.

city

string

required

City the order is being shipped to.

zip_code

string

required

Zip code the order is being shipped to.

country

object

required

Country the order is being shipped to.

vat_id

string | null

VAT number of the business, assigned by the government of that country.

string | null

Billing or Accounts Payable email to which all payment communications are sent.

phone

string | null

Business phone number as mentioned during the business registration with the government.

language

string | null

Buyer's preferred language

status

string

required

ACTIVE - ACTIVE
UNDER_REVIEW - UNDER_REVIEW
INACTIVE - INACTIVE
BLOCKED - BLOCKED
REJECTED - REJECTED

ACTIVE UNDER_REVIEW INACTIVE BLOCKED REJECTED

buyer_users

array of objects

required

buyer_users*

object

user_id

string

required

Sprinque generated ID to uniquely identify each new user registered.

first_name

string

required

First name of the business user.

last_name

string

required

Last name of the business user.

date_of_birth

date | null

Date of birth of the business user. Format in YYYY-MM-DD

role

string

required

ADMIN - Admin
MEMBER - Member

ADMIN MEMBER

string

required

Email of the business user.

phone

string | null

Phone number of the business user.

language

string | null

The preferred language for communication with the user. If it's not specified, buyer's default language will be used.

email_otp_validated

boolean

required

This indicates whether the user has been validated by OTP email verification.

credit_qualification

object

required

credit_decision

string

required

PENDING - Pending
APPROVED - Approved
REJECTED - Rejected
BLOCKED - Blocked
MANUAL_REVIEW - Manual Review

PENDING APPROVED REJECTED BLOCKED MANUAL_REVIEW

payment_terms

Payment terms assigned based on the risk assessment.

NET7 - NET7
NET15 - NET15
NET30 - NET30
NET45 - NET45
NET60 - NET60
NET90 - NET90
PAY_IN_3 - PAY_IN_3
PAY_IN_6 - PAY_IN_6
PAY_IN_9 - PAY_IN_9
PAY_IN_12 - PAY_IN_12
PAY_IN_ADVANCE - PAY_IN_ADVANCE

eligible_payment_terms

array | null

Different payment terms for which the buyer is eligible.

eligible_payment_terms

credit_limit

string

required

Numeric value of the credit approved for PBI based on Sprinque risk assessment.

available_credit_limit

string | null

Numeric value of the credit available for invoice financing.

credit_limit_currency

string | null

Currency code of the credit limit and available credit limit.

metadata

object | null

Metadata is a json object for passing any custom information like the digital footprint of the buyer. This can include fields such as, IP address, browser type etc.

Has additional fields

trace_id

string

required

Unique ID to identify each API call.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sandbox.sprinque.com/api/v1/buyers/buyer_id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200