Lookup buyers

get https://api-preview.platform.breadpayments.com/api/buyer

Allows a user to lookup buyers using filtering query parameters.

A user can lookup by phone and/or email. To lookup a single buyer with a verified phone and/or email, the verifiedPhoneOnly and verifiedEmailOnly filters can be used.

For a valid request, at least one of the phone.eq and email.eq filters is required. If the verifiedPhoneOnly or verifiedEmailOnly filters are true, phone.eq or email.eq must also be provided respectively.

Query Params

phone.eq

string

Searches exact match on phone. Must be URI encoded.

email.eq

string

Searches exact match on email. Must be URI encoded.

verifiedPhoneOnly

boolean

Filters the response to only include a buyer if the provided phone is verified.

verifiedEmailOnly

boolean

Filters the response to only include a buyer if the provided email is verified.

duplicatePhoneOnly

boolean

Filters the response to only include a buyer if the provided phone is a duplicate.

duplicateEmailOnly

boolean

Filters the response to only include a buyer if the provided email is a duplicate.

limit

integer

1 to 200

Defaults to 10

The maximum number of records that will be returned in a result set.

offset

integer

≥ 0

Defaults to 0

The number of records to skip before starting to collect the result set. Used in conjunction with limit query parameter for pagination support

Responses

Response body

object

buyers

array of objects

buyers

object

activeAuthorizedThirdParties

array of objects

Subresource of buyer and acted on with its own set of endpoints

activeAuthorizedThirdParties

object

buyerID

uuid

The ID of the buyer on whose behalf this authorized third party is allowed to act.

consentToCall

boolean

Defaults to false

Whether this authorized third party has consented to receive calls.

consentToEmail

boolean

Defaults to false

Whether this authorized third party has consented to receive emails.

consentToText

boolean

Defaults to false

Whether this authorized third party has consented to receive text messages.

createdAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

string

Email address

uuid

Unique ID associated with this authorized third party.

isActive

boolean

Defaults to false

Indicates whether this authorized third party is active.

name

object

required

Represents the full name

phone

string

required

Telephone number including country code

powerOfAttorney

boolean

Defaults to false

Indicates whether this authorized third party has power of attorney for the associated buyer. Power of attorney legally grants a third party the ability to represent the buyer in private affairs.

attorneyRepresentation

boolean

Defaults to false

Indicates whether this authorized third party is an attorney acting on behalf of the buyer.

type

string

AuthorizedThirdPartyType represents a authorized third party type as enum
Possible values: AUTHORIZED_THIRD_PARTY, POWER_OF_ATTORNEY, ATTORNEY_REPRESENTATION, GUARDIANSHIP

phoneType

string

PhoneType represents a phone type as enum
Possible values: MOBILE, WORK, HOME, OTHER

updatedAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

contacts

object

required

BuyerContactMap represents a mapping of buyer contact IDs to contacts

createdAt

date-time

required

The timestamp value formatted per RFC3339. This does not allow nulls.

employment

object

Optional. Employment represents the buyer's employment.

uuid

required

Unique ID associated with this buyer.

identity

object

required

Identity represents the identity of a buyer

languagePreference

string

required

length ≥ 2

The two language code as defined in ISO 639-1 along with subtags tag if applicable.

primaryContactID

uuid

required

Read-only. The ID of the primary contact information associated with this buyer; this is set on buyer creation.

status

string

Status represents buyer status as string. Options available will depend
on tenant level configurations

subStatus

string

SubStatus represents buyer sub status as constant string. Options
available will depend on status value and tenant level configurations

tenantID

uuid

required

ID of the tenant associated with this buyer.

activeMilitary

boolean

Indicates if the buyer is a member of the armed forces.

bankruptcy

object

Bankruptcy represents a buyer's bankruptcy information

doNotSellOrShare

boolean

Indicates if the buyer has preference for their data not to be shared

primaryContact

object

BuyerContact represents a set of contact information.

doNotSellOrShareUpdatedAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

updatedAt

date-time

required

The timestamp value formatted per RFC3339. This does not allow nulls.

limit

integer

The limit value used.

offset

integer

The offset value used.

total

integer

The total count of buyers found in the database, if any.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api-preview.platform.breadpayments.com/api/buyer?limit=10&offset=0' \
3
     --header 'accept: application/json'

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

application/json

text/plain

200A list of buyers that match the filtering criteria.

400Response for errors returned by buyer service.

401Unauthorized. Indicates that provided credentials is not valid

403Forbidden. Indicates that request cannot be authorized

500Response for errors returned by buyer service.