Get the active vouch the caller already holds on a subject

GET

/vouches/pair-state

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.ethos.network/api/v2/vouches/pair-state?subjectUserkey=example"),
    Headers =
    {
        { "X-Ethos-Api-Key", "<X-Ethos-Api-Key>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.ethos.network/api/v2/vouches/pair-state?subjectUserkey=example"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("X-Ethos-Api-Key", "<X-Ethos-Api-Key>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.ethos.network/api/v2/vouches/pair-state?subjectUserkey=example")
  .get()
  .addHeader("X-Ethos-Api-Key", "<X-Ethos-Api-Key>")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.ethos.network/api/v2/vouches/pair-state',
  params: {subjectUserkey: 'example'},
  headers: {'X-Ethos-Api-Key': '<X-Ethos-Api-Key>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.ethos.network/api/v2/vouches/pair-state?subjectUserkey=example';
const options = {method: 'GET', headers: {'X-Ethos-Api-Key': '<X-Ethos-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.ethos.network/api/v2/vouches/pair-state";

    let querystring = [
        ("subjectUserkey", "example"),
    ];

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("X-Ethos-Api-Key", "<X-Ethos-Api-Key>".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.get(url)
        .query(&querystring)
        .headers(headers)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url 'https://api.ethos.network/api/v2/vouches/pair-state?subjectUserkey=example' \
  --header 'X-Ethos-Api-Key: <X-Ethos-Api-Key>'

Answers for the pair, not for one encoding: every wallet the caller holds is checked against every userkey of the subject, across both vouch versions. The author is always the authenticated caller, so the answer only ever describes the caller’s own vouch. Use it before offering to vouch — a non-none answer means the V2 write paths that run the pair rule would refuse a new vouch, and the existing vouch is the one to increase or convert. > ⚠️ Warning: This is a beta endpoint. It is not guaranteed to be stable and may change or break without notice.

Authorizations

ApiKey
Authorization

Parameters

Query Parameters

subjectUserkey

required

string

Responses

200

Successful response

application/json

One of:

object

vouchId

required

integer

<= 9007199254740991

kind

required

string

Allowed value: v1

Example

{
  "kind": "v1"
}

400

Invalid input data

application/json

Invalid input data error (400)

The error information

object

message

required

The error message

string

code

required

The error code

string

issues

An array of issues that were responsible for the error

Array<object>

object

message

required

string

Example

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401

Authorization not provided

application/json

Authorization not provided error (401)

The error information

object

message

required

The error message

string

code

required

The error code

string

issues

An array of issues that were responsible for the error

Array<object>

object

message

required

string

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403

Insufficient access

application/json

Insufficient access error (403)

The error information

object

message

required

The error message

string

code

required

The error code

string

issues

An array of issues that were responsible for the error

Array<object>

object

message

required

string

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

404

Not found

application/json

Not found error (404)

The error information

object

message

required

The error message

string

code

required

The error code

string

issues

An array of issues that were responsible for the error

Array<object>

object

message

required

string

Example

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500

Internal server error

application/json

Internal server error error (500)

The error information

object

message

required

The error message

string

code

required

The error code

string

issues

An array of issues that were responsible for the error

Array<object>

object

message

required

string

Example

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}