Check A User's Provisioning Status

post

https://sandbox.dmhisp.com:7443/DirectProvisioningApi/User/Status

This method is used by Trusted Agents, or TAs, to submit a certificate application to a DataMotion Officer for review. Once a DataMotion Officer reviews and approves the certificate application, a Patient Certificate (patient cert) will be generated and installed, and the Direct Address bound to the patient cert will be provisioned on the DataMotion HISP.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

TrustedAgent

string

required

The TA to be named on the certificate application

OrganizationName

string

required

The legal business name of the organization to which the patient belongs, as established in the DPP

OrganizationCategory

string

enum

required

The HIPAA-compliance type for the organization (4 = Patient)

Allowed:

FirstName

string

required

The first name of the patient

LastName

string

required

The last name of the patient

City

string

required

The city where the patient is located

State

string

required

The state where the patient is located

Country

string

required

The country where the patient is located

Lifetime

int32

required

The duration of the certificate with allowed values of 1, 2, or 3 years

CommonName

string

required

The first and last name of the patient

SubjectAltName

string

required

The Direct Messaging address to be created for the patient

AutoRenew

boolean

required

Indicates whether or not the certificate should be automatically renewed upon expiration

DelegateIdProofing

string

required

Indicates that the TA accepts responsibility that the identity of the patient covered by this certificate has been fully vetted to IAL2 standards

EmailAddress

string

required

The notification address to be used for sending notifications including user provisioning. This is not the address used for the Direct address.

Notes

string

Any notes to submit to the DataMotion Officer to review with the certificate application

Headers

X-User-Id

string

required

The email/username of the TA as established on the DPP

X-User-Password

string

required

The password of the TA as established on the DPP

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400