Introduction
The purpose of this document is to provide a summary of the data exchanged between the client application and the PII Vault Web Services/APIs.
All requests in the API return a JSON response with some specific fields that make all API responses consistent regardless of what end point is called.
Requests
The following classes represent the data sent to and from our API as JSON
| Class | Property | Type |
| ProfileModel | ||
| SourceSystemKey | String | |
| FirstName | String | |
| MiddleName | String | |
| LastName | String | |
| DateOfBirth | DateTime | |
| Gender | String | |
| Emails | ProfileEmailModel | |
| Phones | ProfilePhoneModel | |
| Addresses | ProfileAddressModel | |
| Keys | ProfileKeyModel | |
| ProfileEmailModel | ||
| PhoneType | String | |
| PhoneOwner | String | |
| PhoneNumber | String | |
| ProfileAddressModel | ||
| AddressType | String | |
| StreetAddress1 | String | |
| StreetAddress2 | String | |
| City | String | |
| State | String | |
| Zip | String | |
| Country | String | |
| ProfileKeyModel | ||
| KeyType | String | |
| KeyOwner | String | |
| KeyValue | String | |
| PseudonymRequestModel | ||
| SeedValue | Integer | |
| SourceSystemKey | String |
Responses
The classes below represent data returned from our API as JSON
| Class | Property | Type |
| ProfileListResponseModel | ||
| ProfileResponseModel | List | |
| ProfileResponseModel | ||
| Index | Integer | |
| SourceSystemKey | String | |
| PolyId | Guid | |
| ProfilePseudonymModel | ||
| ReturnCode | Integer | |
| SourceSystemKey | String | |
| DateOfBirth | DateTime | |
| Gender | String | |
| FirstName | String | |
| MiddleName | String | |
| LastName | String | |
| EmailAddress | String | |
| Address | String | |
| Phone | String | |
| KeyType | String | |
| KeyValue | String | |
| Street1 | String | |
| Street2 | String | |
| City | String | |
| State | String | |
| Zipcode | String | |
| Message | String |