Reviewing Registration Requests
This section describes how to review and manually approve or decline registration requests. This process applies to registration requests that meet the criteria for manual approval specified by a standard rule for the group or by a pre-auth rule.
Viewing Requests Pending Manual Approval
To view all registration requests for a membership group A logical grouping of multiple Corda identities, which communicate and transact with each other using a specific set of CorDapps. , use the GET method of the mgm/{holdingidentityshorthash}/approval/registrations endpoint.
curl -k -u $REST_API_USER:$REST_API_PASSWORD $REST_API_URL/mgm/$MGM_HOLDING_ID/approval/registrations
Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)} -Uri "$REST_API_URL/mgm/$MGM_HOLDING_ID/approval/registrations"
This method returns the requests in the following format:
{
"memberInfoSubmitted": {
"data":
},
"reason": "string",
"registrationId": "string",
"registrationSent": "2023-06-24T10:15:30Z",
"registrationStatus": "PENDING_MANUAL_APPROVAL",
"registrationUpdated": "2023-06-24T10:15:30Z"
}
Requests that are pending manual approval have the status PENDING_MANUAL_APPROVAL
.
To view requests from a specific member
Corda identity that has been granted admission to a membership group. Synonym for a virtual node or group member.
(for example, C=GB, L=London, O=Alice
):
curl -k -u $REST_API_USER:$REST_API_PASSWORD $REST_API_URL/mgm/$MGM_HOLDING_ID/approval/registrations?requestsubjectx500name=C%3DGB%2C%20L%3DLondon%2C%20O%3DAlice'
Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)} -Uri "$REST_API_URL/mgm/$MGM_HOLDING_ID/approval/registrations?requestsubjectx500name=C%3DGB%2C%20L%3DLondon%2C%20O%3DAlice"
To include historic requests, set the viewhistoric
parameter to true
:
curl -k -u $REST_API_USER:$REST_API_PASSWORD $REST_API_URL/mgm/$MGM_HOLDING_ID/approval/registrations?requestsubjectx500name=C%3DGB%2C%20L%3DLondon%2C%20O%3DAlice&viewhistoric=true'
Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)} -Uri "$REST_API_URL/mgm/$MGM_HOLDING_ID/approval/registrations?requestsubjectx500name=C%3DGB%2C%20L%3DLondon%2C%20O%3DAlice&viewhistoric=true"
Approving a Request
To approve a rquest, pass the ID of the request to the POST method of the mgm/{holdingidentityshorthash}/approve/{requestid} endpoint. You can retrieve the ID of a request from the response of the GET endpoint described in Viewing Requests Pending Manual Approval.
curl -k -u $REST_API_USER:$REST_API_PASSWORD -X POST $REST_API_URL/mgm/$MGM_HOLDING_ID/approve/<REQUEST-ID>
Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)} -Method Post -Uri "$REST_API_URL/mgm/$MGM_HOLDING_ID/approve/<REQUEST-ID>"
PENDING_MANUAL_APPROVAL
status.Declining a Request
To decline a request, pass the ID of the request and a reason to the POST method of the mgm/{holdingidentityshorthash}/decline/{requestid} endpoint. You can retrieve the ID of a request from the response of the GET endpoint described in Viewing Requests Pending Manual Approval.
curl -k -u $REST_API_USER:$REST_API_PASSWORD -d <REASON> $REST_API_URL/mgm/$MGM_HOLDING_ID/decline/<REQUEST-ID>
Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)} -Method Post -Uri "$REST_API_URL/mgm/$MGM_HOLDING_ID/decline/<REQUEST-ID>" -Body "<REASON>"
PENDING_MANUAL_APPROVAL
.Was this page helpful?
Thanks for your feedback!
Chat with us
Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.
Propose documentation improvements directly
Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.
We're sorry this page wasn't helpful. Let us know how we can make it better!
Chat with us
Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.
Create an issue
Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.
Propose documentation improvements directly
Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.