View source for API Method DirectAddressValidate




== Description ==
The following code samples describe the processes involved in "validating" a Direct address and discuss what happens behind the scenes with domain-level address validation and address-level validation.
  

== Behind the Scenes ==
When a call is made to <code>/DirectAddressValidate</code>, a search is performed for a current, non-revoked certificate for the target Direct address.  There two types of certificates to search for:

=== Address-level Certificates ===
For a recipient Direct address of <code>DrTom@DrTomsPractice.MyEHRDirect.com</code>, the first certificate search looks for a certificates issued for the recipient address: <code>DrTom@DrTomsPractice.MyEHRDirect.com</code>.  If the immediate issuer (or any of the parent issuers) of the certificate is trusted and the certificate has not been revoked, then <code>/DirectAddressValidate</code> will return <code>true</code>. This does '''not''' mean that the address itself is guaranteed to exist or that messages sent to it will be picked up by the intended recipient - only that a valid, non-revoked certificate signed by a trusted agency can be found for the address

=== Domain-level Certificates ===
For a recipient Direct address of <code>DrBob@DrBobsPractice.OtherEHRDirect.com</code>, if no trusted, non-revoked certificate can be found for the ''address'', the next certificate search will be performed on the ''domain'' of the intended recipient: <code>DrBobsPractice.OtherEHRDirect.com</code>.  A Domain-level certificate is used for all users in a given domain.  The same certificate will be used to sign messages from <code>DrBob@DrBobsPractice.OtherEHRDirect.com</code> as will be used to sign messages from <code>NurseRatchett@DrBobsPractice.OtherEHRDirect.com</code>.  Since there ''aren't'' any user-specific (aka Address-specific) certificates available to be searched, the most precise anyone can be about determining if the recipient Direct-address is valid is to confirm the existence of a trusted, non-revoked certificate for the domain.  Again, this does '''not''' mean that the address itself is guaranteed to exist or that messages sent to it will be picked up by the intended recipient - only that a valid, non-revoked certificate signed by a trusted agency can be found for the domain.

==  Prerequisites ==

{{PreReq Vendor Credentials}}

== Code Samples ==
{| class="wikitable" style="width:900px; vertical-align:top; align:left"
! Language || Source Code Examples
|-
| width="50px"| C# || <div class="mw-collapsible mw-collapsed" style="width:65px">
<div class="mw-collapsible-content" style="width:810px">
   
{{Core Method Header - CSharp}}
{{Json DirectAddressValidate Block - CSharp}}
{{Json Auth Block - User - CSharp}}
{{Core Method Footer - CSharp|directAddressValidate|directAddressValidate}}
  
{{Base_Code_for_Consuming_API_Using_CSharp}}
</div>
|-
| align="top" | Java || <div class="mw-collapsible mw-collapsed" style="width:65px">
<div class="mw-collapsible-content" style="width:810px">
{{Talk To Updox - Core - Java|directAddressValidate|directAddressValidate}}
  
{{Json RequestBlock Header - Java}}
{{Json DirectAddressValidate Block - Java}}
{{Json AuthBlock User - Java}}
{{Json RequestBlock Footer - Java}}
  
{{Base_Code_for_Consuming_API_Using_Java}}
|}

== Messages ==
=== Destination Address ===
<div style="width:500px;">
  {{Base url api|directAddressValidate|directAddressValidate}}
</div>

=== Request JSON ===
<div style="width:500px;">
{{Json Request DirectAddressValidate}}
</div>

=== HTTP Response Status ===
<div style="width:500px;">
  200 OK
</div>

=== Response JSON ===
<div style="width:500px;">
{{Json Response DirectAddressValidate}}
</div>

  
  
  
  
== Relevant Response Codes == 
{{Relevant Response Codes Table Header}}