Skip to main content
POST
Ready For Approval

Overview

When an ID application is ready (all attachments have been signed and uploaded), the client can call this resource to flag the application as ready for approval. This will execute any automated onboarding procedures to analyze the application, and, if passing them, will take the identity to the approved state. They can also take the application to the rejected state, in case they find the information invalid.

Authentication

Requires a valid JWT bearer token. Call this after all required attachments are uploaded while the identity is Created. If the sandbox has already approved it, skip this request. Then retrieve the identity to observe its state. Follow the identity application guide for complete signed HTTP requests.

Notes

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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Referer
string<uri>
required

Your application's HTTPS URL, for example https://app.example.com/. Include this header on every Agent API request, including backend calls, login, and account creation. Browser clients must use a referrer policy that sends the application origin. See /neuron-api/api-basics#required-referer-header.

Body

application/json
keyId
string
required

The signing key used for the application.

Identity.id of your completed application in Created state.

nonce
string
required

A fresh random nonce of at least 32 characters. Do not reuse an upload nonce.

keySignature
string
required

Base64 HMAC-SHA-256 of the key message using the key password.

requestSignature
string
required

Base64 HMAC-SHA-256 of keyMessage:keySignature:nonce:legalId using the account password.

Response

200 - application/json

Success

Identity
object
required