The IRWS v3 documentation is not complete. Please contact if you have questions about v3 usage.


This guide describes the Identity Registration Web Service (IRWS) API v3. IRWS can be used to to register an identity with the Identity Registry.  IRWS offers a "RESTful" programmatic interface. It exposes Identity Registry source information as addressable resources via the uniform HTTP interface; authorized clients may retrieve (GET), create (PUT), update (POST) and delete (DELETE) representations of these resources through the REST API.

Request IRWS Access

IRWS V3 Swagger Documentation

Swagger documentation for IRWS v3 can be found at Identity Registration Web Service REST API v3.


The application that uses this service must support:

Base URL

All interactions with IRWS are through the following base URLs. Customer testing is generally done in the Eval environment. The Dev environment is reserved for the IAM development team. 

Supported HTTP Request Headers

IRWS supports a set of standard and custom HTTP headers that can be used by a client to express options. All the listed request headers are optional and all can be combined.

Accept: [content type1,content type2, ...]

Act-As: application name

Application-Name: application/userid

Attribute-List: [attribute1 attribute2 attribute3 ...]

If-Match: [etag]

Option-List: [imprecise pretend pretty reflect]

Supported URI Parameters

HTTP headers are the preferred way for an application to express the IRWS options it needs. For convenience, some of the options described above can be communicated via parameters in the URI. This may be useful for user interactive testing with a browser or the curl utility. All parameters are optional and different options may be combined in one URI. Definitions are provided in the previous section. 


Identity records are associated with a resource.  A GET on the base URL will return a list of all top-level resources for which your client is authorized. Documentation is provided for the resources listed in the table below.  (TBD: Update links/pages for v3.)



Account The Account resource allows an authorized client to create, read, update, delete, and perform other actions related to account entities. 
CategoryThe Category resource allows an authorized client to...
DsubscriptionThe Dsubscription resource allows an authorized client to...
NameThe Name resource allows an authorized client to read and update source-independent names associated with person entities.
PdsentryThe PDS Entry resource allows an authorized client to read Person Directory data.
PersonThe Person resource allows an authorized client to create, read, update, delete, and perform other actions related to person entities.  
RegidThe Regid resource allows an authorized client to manipulate attributes associated with regids.
SocialThe Social resource allows an authorized client to create, read, and update social identities. 
SubscriptionThe Subscription resource allows an authorized client to...

Return Codes

IRWS uses standard HTTP return codes, as well as a few special ones. Most errors will return a JSON payload with the error class containing the code and message properties.  

Return Code



200OK (the GET, PUT, or POST was successful)Resource (JSON)
400Invalid identifier type providedError (JSON)


404Identifier provided did not match any recordsError (JSON)


Method Not AllowedError (JSON)
406Content type not supported 


500Internal Server ErrorNone


Not ImplementedNone
503Service UnavailableNone