Docs
Kyb

Get Assessment Report

Returns a signed URL to download the assessment report if available. If the report is still being generated, returns a 202 Accepted status.

GET
/v1/kyb/assessment/:id/report

Path Parameters

idnumber

Assessment ID

Header Parameters

x-api-keystring

Response Body

curl -X GET "https://api.ambriel.io/v1/kyb/assessment/:id/report" \
  -H "x-api-key: string"
fetch("https://api.ambriel.io/v1/kyb/assessment/:id/report", {
  headers: {
    "x-api-key": "string"
  }
})
package main

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

func main() {
  url := "https://api.ambriel.io/v1/kyb/assessment/:id/report"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("x-api-key", "string")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.ambriel.io/v1/kyb/assessment/:id/report"

response = requests.request("GET", url, headers = {
  "x-api-key": "string"
})

print(response.text)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://api.ambriel.io/v1/kyb/assessment/:id/report"))
  .header("x-api-key", "string")
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}
using System;
using System.Net.Http;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "string");
var response = await client.GetAsync("https://api.ambriel.io/v1/kyb/assessment/:id/report");
var responseBody = await response.Content.ReadAsStringAsync();
{
  "success": true,
  "url": "https://r2.cloud.example.com/assessments/12345/report.pdf?signature=abc123"
}
{
  "success": false,
  "message": "Report is being generated"
}
Empty
Empty
{
  "success": false,
  "message": "Assessment not found"
}
Empty