Skip to content
Connect API Catalog
/
Access
/
API Documentation
/
User Administration

Access (1.0.0)

This API provides essential endpoints for user information and authentication, crucial for accessing and utilising any subsequent products.

The authentication endpoint ensures secure access to the main API.

The user endpoints return comprehensive details about logged-in users within the customer's environment and provide higher-level user information.

Additionally, the API allows users to view their subscriptions for available products and the languages that are supported.

Download OpenAPI description
access.json
access.yaml
Languages
Servers
Sandbox server

https://connect.sandbox.creditsafe.com/v1/

Production server

https://connect.creditsafe.com/v1/

Authentication

Endpoints for user authentication into the Connect API.

Operations

User Administration

Endpoints for user management.

Operations

Subscription Details

Request

Returns the available countries in your subscription - Company Report, Director Report, Offline Reports and Monitoring.

Security
bearerToken
curl -i -X GET \
  https://connect.sandbox.creditsafe.com/v1/access \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
correlationIdstring
countryAccessobject
Response
application/json
{
  "correlationId": "string",
  "countryAccess": {
    "creditsafeConnectOnlineReports": [ … ],
    "creditsafeConnectOfflineReports": [ … ],
    "creditsafeConnectMonitoring": [ … ],
    "creditsafeConnectDirectorReports": [ … ],
    "creditsafeConnectImageDocuments": [ … ],
    "creditsafeConnectBankValidation": [ … ],
    "creditsafeConnectBankVerification": [ … ]
  }
}

List of Active Users

Request

Returns a collection of user details with in the customer

Security
bearerToken
curl -i -X GET \
  https://connect.sandbox.creditsafe.com/v1/access/users/active \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
itemsArray of objects
totalSizeinteger(int64)
Response
application/json
{
  "items": [
    { … }
  ],
  "totalSize": 0
}

Logged In User Details

Request

Returns the details of logged in user.

Security
bearerToken
curl -i -X GET \
  https://connect.sandbox.creditsafe.com/v1/access/users/me \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
usernamestring

The name of the user.

Example: "Raj"
emailAddressstring

The email address of the user.

Example: "connectm1@mailinator.com"
owningEntitystring

Owning entity of the user.

Example: "CSUS"
defaultLanguagestring

user default language.

Example: "EN"
primaryContactobject
ietfLanguagestring

user default language.

Example: "en-GB"
countryCodestring

country code of the user.

Example: "en-GB"
isActivestring

status of the user.

Example: "true"
correlationIdstring

A unique ID assigned to this request.

Example: "23921650-c073-11ea-860f-06bc8182190e"
Response
application/json
{
  "username": "Raj",
  "emailAddress": "connectm1@mailinator.com",
  "owningEntity": "CSUS",
  "defaultLanguage": "EN",
  "primaryContact": {
    "title": "",
    "firstName": "",
    "surname": ""
  },
  "ietfLanguage": "en-GB",
  "countryCode": "en-GB",
  "isActive": "true",
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e"
}