Skip to main content
POST
/
api
/
bridge
/
v1
/
available-providers
/
{provider_controller_type_id}
/
available-credentials
/
{credential_controller_type_id}
/
credential
/
user-credential
/
broker
Start credential brokering
curl --request POST \
  --url https://api.example.com/api/bridge/v1/available-providers/{provider_controller_type_id}/available-credentials/{credential_controller_type_id}/credential/user-credential/broker \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_instance_id": "<string>"
}
'
{
  "action": {
    "Redirect": {
      "url": "<string>"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "credential_controller_type_id": "<string>",
  "id": "<string>",
  "metadata": {},
  "provider_controller_type_id": "<string>",
  "provider_instance_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "type": "broker_state"
}

Path Parameters

provider_controller_type_id
string
required

Provider controller type ID

credential_controller_type_id
string
required

Credential controller type ID

Body

application/json
provider_instance_id
string
required

Response

Start user credential brokering

action
required
created_at
string<date-time>
required
credential_controller_type_id
string
required
id
string
required
metadata
object
required
provider_controller_type_id
string
required
provider_instance_id
string
required
updated_at
string<date-time>
required
type
enum<string>
required
Available options:
broker_state