For AI agents: the docs index is at https://domains.opensrs.guide/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

v1.0

Guides

v1.0

Standard Parameters for Trust Order Event Notifications

Quick Start Guide: OpenSRS API Integration for XML

OpenSRS API Quick-Start Guide

Basic Steps

Overview
Construction of the POST Data
Troubleshooting HTTPS Post
Protocol Message Structure
Response Codes
Lookup (domain)
Register (domain)
Get (domain)
Modify (domain)
Renew (domain)
Update Contacts
Renew (premium domain)

OpenSRS Protocol

Overview
Writing your own client

Contact Set

Examples for contact set
Domain contacts
TLD Data
Verify (Check validation .AU)

Lookup Commands

Overview
belongs_to_rsp
get (domain)
get_balance
get_contract
get_deleted_domains
get_domain_affiliate_id
get_domains_by_expiredate
get_domains_contacts
get_notes
get_order_info
get_orders_by_domain
get_price
get_registrant_verification_status
lookup (domain)
name_suggest
uk_get_blocker_contact

SSL Service Commands

Overview
sw_register (trust_service)
cancel_order
create_token
get_capabilities
get_cert
get_order_info
get_product_info
get_products
parse_csr
query_approver_list
request_on_demand_scan
resend_approve_email
resend_cert_email
update_dv_auth
update_order
update_product

Provisioning Commands

Overview
sw_register (domain)
activate (domain)
cancel_pending_orders
modify (domain)
process_pending
query_queued_request
redeem (domain)
renew (domain)
revoke (domain)
send_registrant_verification_email
set_domain_affiliate_id
update_contacts
modify_messaging_language

ICANN Trade

Overview
modify_trade_lock_setting
modify_trade_designated_agent
enable_designated_agent
get_trade_lock_setting
get_trade_designated_agent
cancel_icann_trade
resend_trade_approval_notice

Sub-Reseller Commands

Overview
Acting on behalf of subresellers
create subreseller
modify subreseller
get subreseller
pay subreseller

Personal Names Service

Overview
su_register
query (surname)
update (surname)
delete (surname)

Transfer Commands

Overview
cancel_transfer
check_transfer
get_transfers_away
get_transfers_in
process_transfer
send_password (transfer)
trade_domain

Bulk Change Commands

Overview
submit (bulk_change)
submit_bulk_change (WHOIS Privacy)

Nameserver Commands

Overview
create (nameserver)
advanced_update_nameservers
delete (nameserver)
get (nameserver)
modify (nameserver)
registry_add_ns
registry_check_nameserver

DNSSEC Commands

Overview
modify (DNSSEC)
get (DNSSEC)
set_dnssec_info

DNS Zone Commands

Overview
create_dns_zone
delete_dns_zone
force_dns_nameservers
get_dns_zone
reset_dns_zone
set_dns_zone

Domain Forwarding Commands

Overview
delete_domain_forwarding
create_domain_forwarding
get_domain_forwarding
set_domain_forwarding

User Commands

Overview
add (subuser)
delete (subuser)
get (subuser)
get (userinfo)
modify (subuser)

Authentication Commands

Overview
change (ownership)
send_authcode
send_password (domain)

Event Notifications

Event Notifications Overview
Standard Event Notification Parameters
Standard Parameters for Domain Event Notifications
Standard Parameters for Order Event Notifications
Standard Parameters for Transfer Event Notifications
Webhooks Overview
Domain Event: Created
Domain Event: Registered
Domain Event: Renewed
Domain Event: Expired
Domain Event: Deleted
Domain Event: nameserver_update
Domain Event: registrant_verification_status_change
Domain Event: zone_check_status_change
Domain Event: message_status_change
Order Event: claim_status_change
Order Event: status_change
Order Event: message_status_change
Transfer Event: status_change
Transfer Event: message_status_change
Trust Order Event: message_status_change
poll_event
ack_event
icann_trade_status_change

Data Use and Consent Management

gdpr_send_consent_reminder_email

Appendix A: Special Considerations for Asynchronous Registries

Overview

Appendix B: Customizing the Transfer Approval URL

Overview

Appendix C: Encoding Types for IDNs

Overview

Powered by

Standard Parameters for Trust Order Event Notifications

Response Parameters for Trust Order Event Notifications

AWAITING INFO FROM DANNY

Parameter name	Obligation	Definition/Value

Updated 12 months ago

OpenSRS API Quick-Start Guide

- Response Parameters for Trust Order Event Notifications