Openprovider Customer API
The Customer API from Openprovider — 2 operation(s) for customer.
The Customer API from Openprovider — 2 operation(s) for customer.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/openprovider-customer-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: REST AdditionalData Customer API
version: 1.0.0-beta
servers:
- url: https://api.openprovider.eu
security:
- Bearer: []
tags:
- name: Customer
paths:
/v1beta/customers:
get:
tags:
- Customer
summary: List customers
externalDocs:
description: For more detailed information on this method check our guide
url: https://openprovider.zendesk.com/knowledge/articles/360024737413
operationId: ListCustomers
parameters:
- description: Your reseller id is used by default. Other values not accepted.
name: reseller_id
in: query
schema:
type: integer
format: int32
- description: Output limit.
name: limit
in: query
schema:
type: integer
format: int32
- description: Output offset.
name: offset
in: query
schema:
type: integer
format: int32
- description: Output ordering pattern. ASC / DESC.
name: order
in: query
schema:
type: string
- description: Order output by field (i.e. first_name).
name: order_by
in: query
schema:
type: string
- description: Full or partial email address. Wildcard (*) can be used.
name: email_pattern
in: query
schema:
type: string
- description: Full or partial company name. Wildcard (*) can be used.
name: company_name_pattern
in: query
schema:
type: string
- description: Full or partial last name. Wildcard (*) can be used.
name: last_name_pattern
in: query
schema:
type: string
- description: Full or partial first name. Wildcard (*) can be used.
name: first_name_pattern
in: query
schema:
type: string
- description: Full or partial comment value. Wildcard (*) can be used.
name: comment_pattern
in: query
schema:
type: string
- description: Full or partial handle name. Wildcard (*) can be used.
name: handle_pattern
in: query
schema:
type: string
- description: ull or partial first name or last name or company name or handle. Wildcard (*) can be used.
name: pattern
in: query
schema:
type: string
- description: Retrieves objects with (1) or without (0) additional data.
name: with_additional_data
in: query
schema:
type: boolean
format: boolean
- description: 'Customer type: ''company'' or ''individual''. If customer has not empty ''companyName'' than type is ''company'', otherwise ''individual''.'
name: type
in: query
schema:
type: string
- description: 'Сolumns to retrieve. Possible values: ''firstName'', ''prefix'', ''initials'', ''lastName'', ''companyName'', ''email'', ''handle'', ''id'', ''fullName''.'
name: columns
in: query
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/customerListCustomersResponse'
default:
description: (empty)
content:
application/json:
schema:
$ref: '#/components/schemas/errorError'
post:
tags:
- Customer
summary: Create customer
externalDocs:
description: For more detailed information on this method check our guide
url: https://openprovider.zendesk.com/knowledge/articles/360024622893
operationId: CreateCustomer
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/customerCreateCustomerResponse'
default:
description: (empty)
content:
application/json:
schema:
$ref: '#/components/schemas/errorError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/customerCreateCustomerRequest'
required: true
/v1beta/customers/{handle}:
get:
tags:
- Customer
summary: Get customer
externalDocs:
description: For more detailed information on this method check our guide
url: https://openprovider.zendesk.com/knowledge/articles/360024737413
operationId: GetCustomer
parameters:
- description: Customer unique identifier or handle, which can be created via CreateCustomer API method
name: handle
in: path
required: true
schema:
type: string
- description: Retrieves objects with (1) or without (0) additional data.
name: with_additional_data
in: query
schema:
type: boolean
format: boolean
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/customerGetCustomerResponse'
default:
description: (empty)
content:
application/json:
schema:
$ref: '#/components/schemas/errorError'
put:
tags:
- Customer
summary: Update customer
externalDocs:
description: For more detailed information on this method check our guide
url: https://openprovider.zendesk.com/knowledge/articles/360024591034
operationId: UpdateCustomer
parameters:
- description: Customer unique identifier or handle, which can be created via CreateCustomer API method
name: handle
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/customerUpdateCustomerResponse'
default:
description: (empty)
content:
application/json:
schema:
$ref: '#/components/schemas/errorError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/customerUpdateCustomerRequest'
required: true
delete:
tags:
- Customer
summary: Delete customer
externalDocs:
description: For more detailed information on this method check our guide
url: https://openprovider.zendesk.com/knowledge/articles/360024591294
operationId: DeleteCustomer
parameters:
- description: Customer unique identifier or handle, which can be created via CreateCustomer API method
name: handle
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/customerDeleteCustomerResponse'
default:
description: (empty)
content:
application/json:
schema:
$ref: '#/components/schemas/errorError'
components:
schemas:
customerFile:
type: object
title: File
properties:
description:
type: string
title: Brief description of the file content
doc_type:
type: string
title: Type of the document, e.g. 'passport', 'id'
path:
type: string
title: Link to the external file storage
example:
description: My passport scan
doc_type: passport
path: https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE
customerExtensionAdditionalData:
type: object
title: ExtensionAdditionalData
properties:
data:
title: Response data
$ref: '#/components/schemas/customerExtensionData'
name:
type: string
title: Indicates for which extension additional data is listed
example:
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
customerListCustomersResponse:
type: object
title: ListCustomersResponse
properties:
code:
type: integer
format: int32
title: Response code
data:
title: Response data
$ref: '#/components/schemas/customerListCustomersResponseData'
desc:
type: string
title: Response description
maintenance:
type: boolean
format: boolean
title: Indicates if Openprovider API is on maintenance
warnings:
type: array
title: Array of warning messages
items:
$ref: '#/components/schemas/errorWarning'
example:
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: ''
customerListCustomersResponseDataResults:
type: object
title: ListCustomersResponseDataResults
properties:
additional_data:
title: Collection of data fields that contain additional customer information
$ref: '#/components/schemas/customerCustomerAdditionalData'
address:
title: 'Customer''s address
Address'
$ref: '#/components/schemas/contactAddress'
comments:
type: string
title: 'Handle''s comments
Custom notes to the specified handle'
comments_last_changed_at:
type: string
title: Date of last comments property update
company_name:
type: string
title: 'Customer''s company name
Company name'
deleted_at:
type: string
title: Date of handle deletion
email:
type: string
title: 'Customer''s email
Email address'
email_verification_status:
type: string
title: Status of email verification process for specified handle
extension_additional_data:
type: array
title: Collection of data fields that are required for certain TLDs
items:
$ref: '#/components/schemas/customerExtensionAdditionalData'
handle:
type: string
title: Customer unique identifier or handle, which can be created via CreateCustomer API method
id:
type: integer
format: int32
title: 'Handle''s id
Object ID'
is_deleted:
type: boolean
format: boolean
title: Indicates whether handle is deleted
locale:
type: string
title: Customer's language
name:
title: Customer's full name
$ref: '#/components/schemas/contactName'
phone:
title: 'Customer''s phone
Phone number'
$ref: '#/components/schemas/contactPhone'
reseller_id:
type: integer
format: int32
title: 'Your reseller id
Reseller ID'
tags:
type: array
title: Custom tags applied to entity
items:
$ref: '#/components/schemas/customerTags'
example:
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
errorError:
type: object
title: Error
properties:
code:
type: integer
format: int32
title: Error code
data:
type: string
title: Additional error description
desc:
type: string
title: Error description
example:
code: 0
data: ''
desc: ''
customerUpdateCustomerResponse:
type: object
title: UpdateCustomerResponse
properties:
code:
type: integer
format: int32
title: Response code
data:
title: Response data
$ref: '#/components/schemas/customerUpdateCustomerResponseData'
desc:
type: string
title: Response description
maintenance:
type: boolean
format: boolean
title: Indicates if Openprovider API is on maintenance
warnings:
type: array
title: Array of warning messages
items:
$ref: '#/components/schemas/errorWarning'
example:
code: 0
data:
success: false
desc: ''
customerCreateCustomerResponseData:
type: object
title: CreateCustomerResponseData
properties:
handle:
type: string
title: Customer unique identifier or handle, which can be created via CreateCustomer API method
example:
handle: XX123456-XX
customerListCustomersResponseData:
type: object
title: ListCustomersResponseData
properties:
results:
type: array
title: Array of results
items:
$ref: '#/components/schemas/customerListCustomersResponseDataResults'
total:
type: integer
format: int32
title: Total number of entities matching search criteria
example:
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
customerExtensionData:
type: object
title: ExtensionData
properties:
admin_type:
type: string
title: 'The adminType: enter whether the contact is the administrative contact with the permission to act as an independent agent/recruiter on behalf of the listed registrant.
Applicable to: .jobs'
applicant_purpose:
type: string
title: 'The applicant Purpose
Applicable to: .us'
birth_date:
type: string
title: 'The date of birth of the domain holder or legal representative in case of an organization.The format of the date is YYYY-MM-DD.
Applicable to: .ac.vn, .biz.vn, .com.vn, .edu.vn, .gov.vn, .health.vn, .info.vn, .int.vn, .name.vn, .net.vn, .org.vn, .pro.vn, .ru, .su, .vn, .xn--p1ai'
company_name_cyrillic:
type: string
title: 'The company name in Cyrillic. For companies based outside of Russia can be stated in Latin
Applicable to: .ru, .su, .xn--p1ai'
company_name_latin:
type: string
title: 'The company name in Latin
Applicable to: .ru, .su, .xn--p1ai'
company_registration_number:
type: string
title: 'The company registration number. Required in case if domain requester is a legal entity
Applicable to: .es, .se'
contact_title:
type: string
title: 'The contactTitle should be filled with the title of the domain contact in the organization.
Applicable to: .jobs'
country_of_citizenship:
type: string
title: 'Country of citizenship (only applicable for natural persons if country of residence is not within the eligible countries)
Applicable to: .eu'
customer_uin:
type: string
title: 'Unique identification customer number
Applicable to: .sk'
ens_auth_id:
type: string
title: 'The ensAuthId must be filled with aero authentication ID. Link to apply for an aero authentication ID: http://www.information.aero/registration/manage_your_aero_id/apply
Applicable to: .aero'
ens_key:
type: string
title: 'The ensAuthId must be filled with aero ENS key
Applicable to: .aero'
first_name_cyrillic:
type: string
title: 'The first name in Cyrillic. For individuals based outside of Russia can be stated in Latin
Applicable to: .ru, .su, .xn--p1ai'
first_name_latin:
type: string
title: 'The first name in Latin
Applicable to: .ru, .su, .xn--p1ai'
hr_member:
type: string
title: 'The hrMember: choose whether the contact is a member of the „Human Resource Organization“.
Applicable to: .jobs'
industry_class:
type: string
title: 'The industry class
Applicable to: .jobs'
is_private_enterpreneur:
type: string
title: 'Indicates whether the contact is the private enterpreneur.
Applicable to: .ru, .xn--p1ai'
last_name_cyrillic:
type: string
title: 'The last name in Cyrillic. or individuals based outside of Russia can be stated in Latin
Applicable to: .ru, .su, .xn--p1ai'
last_name_latin:
type: string
title: 'The last name in Latin
Applicable to: .ru, .su, .xn--p1ai'
legal_address_cyrillic:
type: string
title: 'The legal address in cyrillic.If domain owner is based outside of Russia can be supplied in Latin
Applicable to: .ru, .su, .xn--p1ai'
legal_type:
type: string
title: 'The legal type of Customer.
Applicable to: .uk, .co.uk, org.uk, me.uk, .ltd.uk'
middle_name_cyrillic:
type: string
title: 'The middle name in Cyrillic. or individuals based outside of Russia can be stated in Latin
Applicable to: .ru, .su, .xn--p1ai'
middle_name_latin:
type: string
title: 'The middle name in Latin
Applicable to: .ru, .su, .xn--p1ai'
mobile_phone_number:
type: string
title: 'The mobile phone number with SMS function
Applicable to: .ru, .su, .xn--p1ai'
nexus_category:
type: string
title: 'The nexus Category
Applicable to: .us'
org_type:
type: string
title: 'The type of Organization
Applicable to: .fi'
passport_issue_date:
type: string
title: 'The passport issue date
Applicable to: .ru, .su, .xn--p1ai'
passport_issuer:
type: string
title: 'The passport issuer
Applicable to: .ru, .su, .xn--p1ai'
passport_number:
type: string
title: 'The iD / passport number of the domain holder for natural persons or VAT number for companies
Applicable to: .ac.vn, .biz.vn, .com.vn, .edu.vn, .es, .gov.vn, .health.vn, .info.vn, .int.vn, .name.vn, .net.vn, .org.vn, .pro.vn, .ru, .su, .vn, .xn--p1ai'
passport_series:
type: string
title: 'The passport series
Applicable to: .ru, .su, .xn--p1ai'
postal_address_cyrillic:
type: string
title: 'The postal address in cyrillic. If domain owner is based outside of Russia can be supplied in Latin
Applicable to: .ru, .su, .xn--p1ai'
social_security_number:
type: string
title: 'The social security number. Required in case if domain requester is a private individual and passport number is empty
Applicable to: .es, .se'
tax_payer_number:
type: string
title: 'The tax payer number
Applicable to: .ru, .su, .xn--p1ai'
uin:
type: string
title: 'The in order to register .TRAVEL domains the registrant has to provide a UIN "Unique Identification Number". The UIN can be provided to the registrant through an Association Authentification Partner (further information can be found at http://www.travel.travel/index.php/authenticate-register/).
Applicable to: .travel'
user_type:
type: string
title: 'The type of Customer
Applicable to: .dk, .sk'
vat:
type: string
title: 'Vat number. Required in case if domain requester is a legal entity
Applicable to: .ac.vn, .biz.vn, .com.vn, .edu.vn, .gov.vn, .health.vn, .info.vn, .int.vn, .name.vn, .net.vn, .org.vn, .pro.vn, .vn'
website:
type: string
title: 'The website: website must be filled with the correct website URL of the organization.
Applicable to: .jobs'
whois_email:
type: string
title: 'The WHOIS email address of a registrant will only be visible on the web-based WHOIS https://whois.eurid.eu/en/ instead of current email
Applicable to: .eu'
example:
admin_type: '1'
applicant_purpose: P3
birth_date: '1970-01-01'
company_name_cyrillic: Example company
company_name_latin: Example company
company_registration_nu
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openprovider/refs/heads/main/openapi/openprovider-customer-api-openapi.yml