v1
latestSwagger 2.02026-08-041113661.2 MBList customers
Query parameters
Your reseller id is used by default. Other values not accepted.
Output limit.
Output offset.
Output ordering pattern. ASC / DESC.
Order output by field (i.e. first_name).
Full or partial email address. Wildcard (*) can be used.
Full or partial company name. Wildcard (*) can be used.
Full or partial last name. Wildcard (*) can be used.
Full or partial first name. Wildcard (*) can be used.
Full or partial comment value. Wildcard (*) can be used.
Full or partial handle name. Wildcard (*) can be used.
ull or partial first name or last name or company name or handle. Wildcard (*) can be used.
Retrieves objects with (1) or without (0) additional data.
Customer type: 'company' or 'individual'. If customer has not empty 'companyName' than type is 'company', otherwise 'individual'.
Сolumns to retrieve. Possible values: 'firstName', 'prefix', 'initials', 'lastName', 'companyName', 'email', 'handle', 'id', 'fullName'.
Response
A successful response.
Example response
{
"code": 0,
"data": {
"results": [
{
"additional_data": {
"attached_files": [
{
"description": "My passport scan",
"doc_type": "passport",
"path": "https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE"
}
],
"birth_address": "test street 45",
"birth_city": "Test city",
"birth_country": "NL",
"birth_date": "1970-01-01",
"birth_state": "Testprovince",
"birth_zipcode": "123",
"company_registration_city": "Testcity",
"company_registration_number": "XX123456789X04",
"company_registration_subscription_date": "2000-01-01",
"company_url": "https://openprovider.com",
"headquarters_address": "Test street 5",
"headquarters_city": "Testcity",
"headquarters_country": "NL",
"headquarters_state": "Testprovince",
"headquarters_zipcode": "123",
"passport_number": "123456",
"social_security_number": "6543210",
"trading_name": "Openprovider"
},
"address": {
"city": "Test city",
"country": "NL",
"number": "123",
"state": "Testprovince",
"street": "Test street",
"suffix": "A",
"zipcode": "1235 XX"
},
"comments": "",
"comments_last_changed_at": "",
"company_name": "",
"deleted_at": "0000-00-00 00:00:00",
"email": "test@mail.tld",
"email_verification_status": "FAI",
"extension_additional_data": [
{
"data": {
"admin_type": "1",
"applicant_purpose": "P3",
"birth_date": "1970-01-01",
"company_name_cyrillic": "Example company",
"company_name_latin": "Example company",
"company_registration_number": "XX123456789X11",
"contact_title": "CEO",
"country_of_citizenship": "NL",
"customer_uin": "",
"ens_auth_id": "",
"ens_key": "",
"first_name_cyrillic": "Test",
"first_name_latin": "Test",
"hr_member": "",
"industry_class": "19",
"is_private_enterpreneur": "",
"last_name_cyrillic": "Person",
"last_name_latin": "Person",
"legal_address_cyrillic": "13245 Country, City, street, 2",
"legal_type": "FCORP",
"middle_name_cyrillic": "Nikolaevich",
"middle_name_latin": "Nikolaevich",
"mobile_phone_number": "+7 (123) 456-78-90",
"nexus_category": "C31",
"org_type": "1",
"passport_issue_date": "2009-01-11",
"passport_issuer": "Issuer name",
"passport_number": "12345678",
"passport_series": "1234",
"postal_address_cyrillic": "12345 Country, City, street, 1",
"social_security_number": "X123455123X",
"tax_payer_number": "1345678",
"uin": "12345-6",
"user_type": "Individual",
"vat": "XX123456789X12",
"website": "http://example.com",
"whois_email": "test@mail.tld"
},
"name": "ru"
}
],
"handle": "XX123456-XX",
"id": 123456789,
"is_deleted": false,
"locale": "nl_NL",
"name": {
"first_name": "Test",
"full_name": "Test Person",
"initials": "T P",
"last_name": "Person",
"prefix": "Mr"
},
"phone": {
"area_code": "111",
"country_code": "+03",
"subscriber_number": "123456"
},
"reseller_id": 5349,
"tags": [
{
"key": "customer",
"value": "VIP"
}
]
}
],
"total": 999
},
"desc": ""
}