Creditsafe_Get_Company_Credit_Report.ipynb

Kernel: Python 3

Creditsafe - Get Company Credit Report

Give Feedback | Bug report

Tags: #creditsafe #api #enterprise #integrations #company #creditreport

Author: Florent Ravenel

Last update: 2023-04-12 (Created: 2023-03-08)

Description: This notebook will demonstrate how to use the Creditsafe API to get a company credit report.

References:

• Creditsafe Free Trial

• Creditsafe API Documentation

Input

Import libraries

import requests
import naas
from pprint import pprint
import json

Setup Variables

• username: username used to connect to Creditsafe

• password: password used to connect to Creditsafe

• env: if 'sandbox' then we will change BASE URL

• company_id: company ID used in Creditsafe

• siret: SIRET to be set (if French company)

# Inputs
username = naas.secret.get("CREDITSAFE_USERNAME")
password = naas.secret.get("CREDITSAFE_PASSWORD")
env = "sandbox"
company_id = None
siret = "85272297400056"

# Outputs
json_path = 'creditsafe_company_report.json'

Model

Create base url

if env == "sandbox":
    BASE_URL = f"https://connect.sandbox.creditsafe.com/v1"
else:
    BASE_URL = "https://connect.creditsafe.com/v1"    

Get access token

def get_access_token(
    username,
    password
):
    # Init
    url = f"{BASE_URL}/authenticate"
    
    # Headers
    headers = {
        "Content type": "application/json"
    }
    
    # Payload
    data = {
        "username": username,
        "password": password,
    }
    
    # Request
    res = requests.post(url, headers=headers, data=data)
    res.raise_for_status
    if res.status_code == 200:
        return res.json().get("token")
    else:
        return None
    
access_token = get_access_token(username, password)

Get Company Credit Report

def get_company_report(
    access_token,
    company_id=None,
    siret=None
):
    # Init
    company_report = None
    if siret:
        company_id = f'FR-X-{siret}'
    if company_id:
        url = f"{BASE_URL}/companies/{company_id}?language=fr"
        
        # Headers
        headers = {
            "Authorization": f"Bearer {access_token}"
        }

        # Request
        res = requests.get(url, headers=headers)
        res.raise_for_status
        if res.status_code == 200:
            company_report = res.json()
    return company_report, company_id
    
company_report, company_id = get_company_report(
    access_token,
    company_id=company_id,
    siret=siret
)

Output

Display result

if company_report:
    # Display summary
    print("✅ Company summary:")
    pprint(company_report.get("report").get("companySummary"))
    
    # Save json
    if json_path == 'creditsafe_company_report.json':
        json_path = f'creditsafe_company_report_{company_id}.json'
    with open(json_path, 'w') as outfile:
        json.dump(company_report, outfile)
    print("✅ Json saved:", json_path)