get suppliers

post https://api.riskledger.com/alpha/suppliers

Filter, sort and paginate through your list of connected suppliers.

Response

Response body

object

page

object

limit

int64

After any offsetting, how many following results were requested.
Omitted if not limit was not requested.

offset

int64

Requested number of results to ignore from the start of the ordered result list.
Omitted if not offset was not requested.

total

int64

Total number of results before any offset and/or limit were applied,
but after any filtering.

suppliers

array of objects

List of your connected suppliers.
Filtered, sorted and paginated as requested.

suppliers

object

approval

object

approvalExpiresAt

date-time

When the current approval status will expire.
Null if it doesn't have an expiration date i.e. it will not automatically expire.

approvalModifiedAt

date-time

When your organisation last modified the approval status of the supplier.

approvalStatus

string

Your approval status of the supplier e.g. "unapproved", "inprogress", "approved", "rejected", "pending_biz", "expired".

assignedUsers

array of objects

A list of users assigned to the supplier.
NOTE: Assigned users are currently not filterable.

assignedUsers

object

firstName

string

First name of the user.

string

User's UUID.

lastName

string

Last name of the user.

team

string

A string indicating the team of the user. Possible values include: "sales", "security", "compliance", "procurement", "legal", "esg", "it" or "other"

city

string

City of the address used to register with Risk Ledger.

companyNumber

string

Legally-registered company number, if provided.

complianceByDomain

array of objects

Compliance By Domain, ordered by domain order in the framework. Request can't be filtered or sorted by this field.

complianceByDomain

object

domainID

string

ID of the Domain

domainName

string

Name of the Domain

numNonCompliantControls

int64

Number of controls not compliant in the domain

percentageCompliance

int64

0 to 100

How much their answers in this specific domain comply with your policies that are being applied to the supplier.

connectedAt

date-time

When you connected to the supplier on Risk Ledger.

country

string

Country of the address used to register with Risk Ledger.

framework

object

string

Organisation UUID.

initialAssessmentCompletedAt

date-time

When the initial assessment was completed.
Null if not completed yet.

initialAssessmentProgress

int64

0 to 100

Percentage progress of the supplier completing their initial assessment.
100% progress does not necessarily mean the assessment was submitted/completed.

labels

array of objects

Labels are the custom labels associated with the supplier. Ordered alphabetically by the label's name.
NOTE: Labels are currently not filterable.

labels

object

description

string

A string detailing the description of the label.

string

UUID of the label.

name

string

A string representing the name of the label.

lastActiveAt

date-time

The last time they modified an assessment answer.
Null if they've not started their initial assessment yet.

lastAssessmentDate

date-time

Last Assessment Date is the date of the previous assessment or reassessment completed.
Can be null if no assessment has been completed.

logoUrl

string

Supplier's logo.

managed

boolean

True if the supplier profile is managed by Risk Ledger.
False if it's managed by someone from the supplier organisation itself.

name

string

Name of the supplier organisation.

nextReassessmentDueDate

date-time

Next Reassessment Due Date is the date the next reassessment is due.
Can be null if no assessment has been completed before.

numActiveDiscussions

int64

Number of discussions you have ongoing with the supplier.
Discussions may include generic discussions or discussions on their specific assessment answers.

numEvidence

int64

Number of evidence files they have uploaded in their assessment.

numExemptionsApplied

int64

Number of exemption overrides your organisation applied to the supplier's non-compliant answers.

numNonComplianceApplied

int64

Number of non-compliance overrides your organisation applied to the supplier's supposedly-compliant answers.

numPoliciesApplied

int64

Number of policies that your organisation has that applies to the supplier.
This determines their compliance percentage.

numRemediationRequests

int64

Number of pending remediation requests you made that the supplier has not responded to yet.

numRemediationResponses

int64

Number of remediation requests you made that the supplier has responded to but is now awaiting
your organisation's confirmation.

percentageCompliance

int64

0 to 100

How much they comply with your policies that are being applied to them.

postalCode

string

Postal code of the address used to register with Risk Ledger.

profileType

string

Profile type refers to whether this supplier is a basic, unclaimed or full connection to the client.

properties

array of objects

Properties are the custom properties associated with the supplier. Ordered alphabetically by the property's name.
NOTE: Properties are currently not filterable.

properties

object

string

UUID of the property.

name

string

A string representing the name of the property.

options

array of strings

An array representing the potential values for the property type. This will be null for types without predefined options.

options

type

string

A string indicating the property type.
Possible values include: "singleSelect", "multiSelect", "text", "number", "date", "boolean", "url", "email".

value

string

Represents the current value set for the property.
leave as interface{} rather than any as it breaks Swagger
Value is an interface here as it can be of any type depending on the property type.
This will be null if the property has no value set.

reassessmentProgress

int64

0 to 100

Percentage progress of the supplier completing their reassessment.
100% progress does not necessarily mean the reassessment was submitted.
This value is 0% while supplier is completing their initial assessment. And 100% when no reassessment is in progress.

streetAddress

string

Street of the address used to register with Risk Ledger.

200