Skip to content
CREDEBL Logo CREDEBL Docs

Sends a out-of-band proof request

POST
/orgs/{orgId}/proofs/oob

Sends a out-of-band proof request

Authorizations

Parameters

Path Parameters

orgId
required
string

Query Parameters

requestType
required
string
Allowed values: indy presentationExchange

Request Body required

object
goalCode
string
protocolVersion
string
comment
string
proofFormats
required
object 
{
  "indy": {
    "name": "Verify national identity",
    "version": "1.0",
    "requested_attributes": {
      "verifynameAddress": {
        "names": [
          "name",
          "address"
        ],
        "restrictions": [
          {
            "schema_id": "KU583UbI4yAKfaBTSz1rqG:2:National ID:1.0.0"
          }
        ]
      },
      "verifyBirthPlace": {
        "name": "Place",
        "restrictions": [
          {
            "schema_id": "KU583UbI4yAKfaBTSz1rqG:2:Birth Certificate:1.0.0"
          }
        ]
      }
    },
    "requested_predicates": {}
  }
}
presentationDefinition
required
Array<object>
object
input_descriptors
required
Array<object>
object
id
required
string
name
required
string
purpose
required
string
schema
required
Array<object>
object
uri
required
string
constraints
required
object
fields
required
Array<object>
object
path
required
Array<string>
{
  "id": "32f54163-7166-48f1-93d8-ff217bdb0653",
  "inputDescriptors": [
    {
      "id": "banking_input_1",
      "name": "Bank Account Information",
      "schema": [
        {
          "uri": "https://bank-schemas.org/1.0.0/accounts.json"
        }
      ],
      "constraints": {
        "fields": [
          {
            "path": [
              "$.issuer"
            ]
          }
        ]
      }
    }
  ]
}
autoAcceptProof
object
label
string
parentThreadId
string
isShortenUrl
required
boolean
true
emailId
Array<string>
reuseConnection
boolean
default: true

Responses

201

Success

object
message
required
string
Success
success
required
boolean
data
required
object
statusCode
required
number
200

401

Unauthorized

object
statusCode
required
number
401
error
required
string
Unauthorized

403

Forbidden

object
statusCode
required
number
403
error
required
string
Forbidden