Skip to main content

​
Overview

Allows the client to retrieve a list of available service providers that can be used to review a recent ID application.

​
HTTP request

POST /Agent/Legal/GetServiceProvidersForIdReview

​
Authentication

Requires a valid JWT bearer token.

​
Request (JSON)

{
	"legalId": "Required(Str(PLegalId))"
}

​
Response (JSON)

{
	"Providers":
	{
		"id": Required(Str(PId)),
		"type": Required(Str(PType)),
		"name": Required(Str(PName)),
		"reviewerId": Required(Str(PReviewerId)),
		"external": Required(Boolean(PExternal)),
		"iconUrl": Optional(Str(PUconUrl)),
		"iconWidth": Optional(Int(PIconWidth)),
		"iconHeight": Optional(Int(PIconHeight))
	}?[]
}

​
Response parameters

ParameterDescription
PIdID of service provider.
PTypeType (class name) of service provider.
PNameDisplayable name for service provider.
PReviewerIdIdentifier of Legal ID of reviewer. Use this identifier when requesting a peer review from the service provider.
PExternalIf the service provider is an external party (true), or hosted on the Neuron (false).
PIconUrlOptional reference to icon that can be displayed together with the name.
PIconWidthWidth of optional icon.
PIconHeightHeight of optional icon.

​
Notes

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