Get a private record

curl --request GET \
  --url https://api.mycreditapp.ai/v1-beta/private-records/{record_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Requester-Organization-ID: <requester-organization-id>' \
  --header 'Target-Organization-ID: <target-organization-id>'

import requests

url = "https://api.mycreditapp.ai/v1-beta/private-records/{record_id}"

headers = {
    "Requester-Organization-ID": "<requester-organization-id>",
    "Target-Organization-ID": "<target-organization-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'Requester-Organization-ID': '<requester-organization-id>',
    'Target-Organization-ID': '<target-organization-id>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.mycreditapp.ai/v1-beta/private-records/{record_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mycreditapp.ai/v1-beta/private-records/{record_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Requester-Organization-ID: <requester-organization-id>",
    "Target-Organization-ID: <target-organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.mycreditapp.ai/v1-beta/private-records/{record_id}"

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

	req.Header.Add("Requester-Organization-ID", "<requester-organization-id>")
	req.Header.Add("Target-Organization-ID", "<target-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mycreditapp.ai/v1-beta/private-records/{record_id}")
  .header("Requester-Organization-ID", "<requester-organization-id>")
  .header("Target-Organization-ID", "<target-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mycreditapp.ai/v1-beta/private-records/{record_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Requester-Organization-ID"] = '<requester-organization-id>'
request["Target-Organization-ID"] = '<target-organization-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "currency_code": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archived": true,
  "archived_at": "2025-12-01T12:34:56.123456",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email": "info@example.com",
  "phone": "+1-555-123-4567",
  "established_date": "2005-08-15",
  "size_id": "6f0d84f7-e442-4ac0-8297-24e1fe6da692",
  "role_id": "292e8dad-37b5-4cb3-8a00-5bb840be894e",
  "naics_code_id": "78b348b8-009c-4b87-af32-60a12fbc6e60",
  "address": "123 Main Street",
  "city": "New York",
  "state": "NY",
  "postal_code": "10001",
  "country_code": "US",
  "website": "https://www.example-corp.com",
  "company_registration_number": "123456789",
  "tax_id": "987654321",
  "corporation_type_id": "de175027-612d-4103-a503-59ef0fe2849b"
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Unsupported CRUD operation!",
      "type": "request",
      "code": "unsupported_crud_operation"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Token is required!",
      "type": "token",
      "code": "token_required"
    },
    {
      "loc": [],
      "msg": "The token has expired!",
      "type": "token",
      "code": "token_expired"
    },
    {
      "loc": [],
      "msg": "Invalid token!",
      "type": "token",
      "code": "invalid_token"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Access denied!",
      "type": "request",
      "code": "access_denied"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Account not found!",
      "type": "request",
      "code": "account_not_found"
    },
    {
      "loc": [],
      "msg": "Organization not found!",
      "type": "request",
      "code": "organization_not_found"
    },
    {
      "loc": [],
      "msg": "Private record not found!",
      "type": "request",
      "code": "private_record_not_found"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "The account is in the process of being deleted! The Account's email can only be reused after its data has been completely deleted. The removal process may take up to 24 hours.",
      "type": "request",
      "code": "account_being_deleted"
    },
    {
      "loc": [],
      "msg": "The organization is in the process of being deleted! The removal process may take up to 24 hours.",
      "type": "request",
      "code": "organization_being_deleted"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "The request is too large!",
      "type": "request",
      "code": "request_too_large"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string",
      "code": "validation_error"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Error processing request, please try later!",
      "type": "try_later",
      "code": "internal_conflict_error"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Service is under maintenance, please try later!",
      "type": "maintanance",
      "code": "service_under_maintenance"
    }
  ]
}

Guest	Host	Self
❌	❌	✅

GET

private-records

{record_id}

Get a private record

curl --request GET \
  --url https://api.mycreditapp.ai/v1-beta/private-records/{record_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Requester-Organization-ID: <requester-organization-id>' \
  --header 'Target-Organization-ID: <target-organization-id>'

import requests

url = "https://api.mycreditapp.ai/v1-beta/private-records/{record_id}"

headers = {
    "Requester-Organization-ID": "<requester-organization-id>",
    "Target-Organization-ID": "<target-organization-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'Requester-Organization-ID': '<requester-organization-id>',
    'Target-Organization-ID': '<target-organization-id>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.mycreditapp.ai/v1-beta/private-records/{record_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mycreditapp.ai/v1-beta/private-records/{record_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Requester-Organization-ID: <requester-organization-id>",
    "Target-Organization-ID: <target-organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.mycreditapp.ai/v1-beta/private-records/{record_id}"

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

	req.Header.Add("Requester-Organization-ID", "<requester-organization-id>")
	req.Header.Add("Target-Organization-ID", "<target-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mycreditapp.ai/v1-beta/private-records/{record_id}")
  .header("Requester-Organization-ID", "<requester-organization-id>")
  .header("Target-Organization-ID", "<target-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mycreditapp.ai/v1-beta/private-records/{record_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Requester-Organization-ID"] = '<requester-organization-id>'
request["Target-Organization-ID"] = '<target-organization-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "currency_code": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archived": true,
  "archived_at": "2025-12-01T12:34:56.123456",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email": "info@example.com",
  "phone": "+1-555-123-4567",
  "established_date": "2005-08-15",
  "size_id": "6f0d84f7-e442-4ac0-8297-24e1fe6da692",
  "role_id": "292e8dad-37b5-4cb3-8a00-5bb840be894e",
  "naics_code_id": "78b348b8-009c-4b87-af32-60a12fbc6e60",
  "address": "123 Main Street",
  "city": "New York",
  "state": "NY",
  "postal_code": "10001",
  "country_code": "US",
  "website": "https://www.example-corp.com",
  "company_registration_number": "123456789",
  "tax_id": "987654321",
  "corporation_type_id": "de175027-612d-4103-a503-59ef0fe2849b"
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Unsupported CRUD operation!",
      "type": "request",
      "code": "unsupported_crud_operation"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Token is required!",
      "type": "token",
      "code": "token_required"
    },
    {
      "loc": [],
      "msg": "The token has expired!",
      "type": "token",
      "code": "token_expired"
    },
    {
      "loc": [],
      "msg": "Invalid token!",
      "type": "token",
      "code": "invalid_token"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Access denied!",
      "type": "request",
      "code": "access_denied"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Account not found!",
      "type": "request",
      "code": "account_not_found"
    },
    {
      "loc": [],
      "msg": "Organization not found!",
      "type": "request",
      "code": "organization_not_found"
    },
    {
      "loc": [],
      "msg": "Private record not found!",
      "type": "request",
      "code": "private_record_not_found"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "The account is in the process of being deleted! The Account's email can only be reused after its data has been completely deleted. The removal process may take up to 24 hours.",
      "type": "request",
      "code": "account_being_deleted"
    },
    {
      "loc": [],
      "msg": "The organization is in the process of being deleted! The removal process may take up to 24 hours.",
      "type": "request",
      "code": "organization_being_deleted"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "The request is too large!",
      "type": "request",
      "code": "request_too_large"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string",
      "code": "validation_error"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Error processing request, please try later!",
      "type": "try_later",
      "code": "internal_conflict_error"
    }
  ]
}

{
  "detail": [
    {
      "loc": [],
      "msg": "Service is under maintenance, please try later!",
      "type": "maintanance",
      "code": "service_under_maintenance"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication using a JWT token. Provide a valid access token. Authorization header format: Authorization: Bearer <token>.

Headers

Requester-Organization-ID

string<uuid>

required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

Example:

"054b4106-174b-46b0-97f8-86d8d7b6f0af"

Target-Organization-ID

string<uuid>

required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Path Parameters

record_id

string<uuid>

required

Unique identifier of the private record

Example:

"b25e7b65-e46a-40d5-a0f2-0de8c2b354aa"

Response

Successful Response

name

string

required

Full name of the organization

Required string length: 1 - 300

Example:

"Example Corporation"

currency_code

string

required

Valid organization's currency code in ISO 4217

Required string length: 3

Example:

"USD"

string<uuid>

required

Unique identifier of the private record

Example:

"b25e7b65-e46a-40d5-a0f2-0de8c2b354aa"

archived

boolean

required

Whether the record is archived

archived_at

string<date-time> | null

required

Timestamp when the record was archived

Example:

"2025-12-01T12:34:56.123456"

created_at

string<date-time>

required

Timestamp when the record was created

Example:

"2025-01-01T09:00:00.123456"

updated_at

string<date-time>

required

Timestamp when the record was updated

Example:

"2025-06-01T15:00:00.123456"

string<email> | null

Official email of the organization

Required string length: 1 - 100

Example:

"info@example.com"

phone

string | null

Contact phone number

Example:

"+1-555-123-4567"

established_date

string<date> | null

Date when the organization was established

Example:

"2005-08-15"

size_id

string<uuid> | null

Identifier of the organization size

Example:

"6f0d84f7-e442-4ac0-8297-24e1fe6da692"

role_id

string<uuid> | null

Identifier of the organization role

Example:

"292e8dad-37b5-4cb3-8a00-5bb840be894e"

naics_code_id

string<uuid> | null

Identifier of the organization NAICS code

Example:

"78b348b8-009c-4b87-af32-60a12fbc6e60"

address

string | null

Valid organization's street address

Required string length: 1 - 500

Example:

"123 Main Street"

city

string | null

Valid organization's city

Required string length: 1 - 100

Example:

"New York"

state

string | null

Valid organization's state or province

Required string length: 1 - 100

Example:

"NY"

postal_code

string | null

Valid organization's postal code

Required string length: 1 - 30

Example:

"10001"

country_code

string | null

Valid organization's country code in ISO 3166-1 alpha-2

Required string length: 2

Example:

"US"

website

string<uri> | null

Valid organization's website URL

Required string length: 1 - 255

Example:

"https://www.example-corp.com"

company_registration_number

string | null

Valid organization's company registration number

Required string length: 1 - 255

Example:

"123456789"

tax_id

string | null

Valid organization's tax identification number

Required string length: 1 - 255

Example:

"987654321"

corporation_type_id

string | null

Identifier of the organization's type of corporation

Required string length: 10 - 100

Example:

"de175027-612d-4103-a503-59ef0fe2849b"

Introduction

API Reference (v1-beta)

Get a private record

Authorization scenarios

Authorizations

Headers

Path Parameters

Response