Skip to main content

​
Overview

Allows the client to petition the owner of a Legal Identity, for information about the identity.

​
HTTP request

POST /Agent/Legal/PetitionId

​
Authentication

Requires a valid JWT bearer token.

​
Request (JSON)

{
	"keyId": Required(Str(PKeyId)),
	"legalId": Required(Str(PLegalId)),
	"remoteId": Required(Str(PRemoteId)),
	"petitionId": Required(Str(PPetitionId)),
	"purpose": Required(Str(PPurpose)),
	"keySignature": Required(Str(PKeySignature)),
	"requestSignature": Required(Str(PRequestSignature))
}

​
Input parameters

ParameterDescription
PKeyIdIdentity of key to use for signing the petition. It must correspond to the key used when signing the Legal Identity application that will be used to sign the petition.
PLegalIdIdentifier of the Legal Identity that will be used to sign the petition.
PRemoteIdIdentifier of the remote legal identity the client requests access to.
PPetitionIdAn identifier of the request, the client can use to correlate asynchronous responses with the corresponding petition request.
PPurposeA human readable text that will be presented to the remote user, describing the purpose of the petition.
PKeySignatureCryptographic signature of the key ID, using the key password.
PRequestSignatureCryptographic signature of the requesut, using the account password.

​
Response (JSON)

{
}

​
Notes

This endpoint uses the request schema notation described in Pattern matching.