The IdentityDocument API does not support XML format.
Add
Add a new IdentityDocument.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| NewObjectResponse with | IdentityDocument added |
| IdentityDocument Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
| A CO Person must be specified to attach the IdentityDocument to | |
| The specified CO Person does not exist | |
| Unknown error |
Delete
Remove an IdentityDocument.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| IdentityDocument deleted | |
|
| |
| Authentication required | |
|
| |
| Unknown error |
Edit
Edit an existing IdentityDocument.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| IdentityDocument updated | |
| IdentityDocument Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
| A CO Person must be specified to attach the Address to | |
| The specified CO Person does not exist | |
|
| |
| Unknown error |
View (all)
Retrieve all existing IdentityDocuments.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| IdentityDocuments returned | |
| Authentication required | |
| Unknown error |
View (per entity)
Retrieve IdentityDocuments attached to a CO Person.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| IdentityDocument returned | |
| The requested CO Person was found, but has no IdentityDocuments attached | |
| Authentication required | |
|
| |
| Unknown error |
View (one)
Retrieve an existing IdentityDocument.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| IdentityDocument returned | |
| Authentication required | |
|
| |
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- cm_identity_documents data model definition