Sellers

List sellers

GET /i/v1/sellers

seller.read. The organisation’s seller as a list of one, filtered by search (name, legal name or tax id); page and limit (up to 100).

Who can call it: API key or signed-in user.

Parameters

Name	In	Type	Required	Description
`search`	query	string	No	Name, legal name or tax id. At most 100 characters.
`page`	query	number	No	Default: `1`. At least 1.
`limit`	query	number	No	Default: `20`. Between 1 and 100.

Example request

bash

curl https://gp.useyona.com/i/v1/sellers \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

One page (zero or one seller), meta.pagination set.

Errors: 400, 401, 403, 429, 503

Get the seller

GET /i/v1/sellers/{id}

seller.read. The organisation’s seller, by its id.

Who can call it: API key or signed-in user.

Parameters

Name	In	Type	Required	Description
`id`	path	string (uuid)	Yes

Example request

bash

curl https://gp.useyona.com/i/v1/sellers/9f8e7d6c-5b4a-3210-fedc-ba9876543210 \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

The seller.

Errors: 400, 401, 403, 404, 429, 503

Search sellers

GET /i/v1/sellers/search

seller.read. The organisation’s seller when its name, legal name or tax id matches q (at least 2 characters); otherwise an empty list.

Who can call it: API key or signed-in user.

Parameters

Name	In	Type	Required	Description
`q`	query	string	Yes	2 to 100 characters.
`limit`	query	number	No	Default: `10`. Between 1 and 20.

Example request

bash

curl "https://gp.useyona.com/i/v1/sellers/search?q=string" \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

Zero or one seller.

Errors: 400, 401, 403, 429, 503

Get the seller and its form options

GET /i/v1/sellers/setup

seller.read. The organisation’s seller, that no further sellers can be added, the tax-id types of its jurisdiction, and the countries.

Who can call it: API key or signed-in user.

Example request

bash

curl https://gp.useyona.com/i/v1/sellers/setup \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

The seller and options.

Errors: 401, 403, 429, 503

Get the seller’s tax number verification status

GET /i/v1/sellers/{id}/verification-status

seller.read. The organisation’s TIN status, as verified in organisation settings.

Who can call it: API key or signed-in user.

Parameters

Name	In	Type	Required	Description
`id`	path	string (uuid)	Yes

Example request

bash

curl https://gp.useyona.com/i/v1/sellers/9f8e7d6c-5b4a-3210-fedc-ba9876543210/verification-status \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

The status.

Errors: 400, 401, 403, 404, 429, 503