Trusthub API documentation

17 days ago

Change #b4ba81c2

1.0.0

Breaking

Compare

31 structure changes including:

5 Additions

26 Modifications

Modified 26 Breaking

POST /v1/TrustProducts/{TrustProductSid}/Evaluations

Response
201 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking

POST /v1/TrustProducts/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking
  - errors property Added

POST /v1/TrustProducts

Response
201 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking
  - errors property Added

POST /v1/SupportingDocuments/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking

POST /v1/SupportingDocuments

Response
201 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking

POST /v1/CustomerProfiles/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking
  - errors property Added

POST /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations

Response
201 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking

POST /v1/CustomerProfiles

Response
201 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking
  - errors property Added

GET /v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking

GET /v1/TrustProducts/{TrustProductSid}/Evaluations

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - status property Modified
      - Type went from string | null to string
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/TrustProducts/{TrustProductSid}/EntityAssignments

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
ObjectType, Page, PageToken query parameters Added

GET /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/TrustProducts/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking
  - errors property Added

GET /v1/TrustProducts

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - status property Modified
      - Type went from string | null to string
        Breaking
    - errors property Added
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/SupportingDocuments/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking

GET /v1/SupportingDocuments

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - status property Modified
      - Type went from string | null to string
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/SupportingDocumentTypes

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Policies

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/EndUsers

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/EndUserTypes

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/CustomerProfiles/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking
  - errors property Added

GET /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking

GET /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - status property Modified
      - Type went from string | null to string
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
ObjectType, Page, PageToken query parameters Added

GET /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/CustomerProfiles

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - status property Modified
      - Type went from string | null to string
        Breaking
    - errors property Added
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

Added 5

POST /v1/ComplianceInquiries/Tollfree/Initialize

POST /v1/ComplianceInquiries/Registration/{RegistrationId}/RegulatoryCompliance/GB/Initialize

POST /v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize

POST /v1/ComplianceInquiries/Customers/{CustomerId}/Initialize

POST /v1/ComplianceInquiries/Customers/Initialize

May 24, 2022

Change #ae964eb5

1.29.1

Breaking

Compare

20 structure changes including:

20 Modifications

Modified 20 Breaking

GET /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations

Response
200 response Modified
- results property Modified

GET /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}

Response
200 response Modified
- results property Modified

GET /v1/EndUserTypes

Response
200 response Modified
- end_user_types property Modified

GET /v1/EndUserTypes/{Sid}

Response
200 response Modified
- fields property Modified

GET /v1/EndUsers

Response
200 response Modified
- results property Modified

GET /v1/EndUsers/{Sid}

Response
200 response Modified
- attributes property Modified

GET /v1/Policies

Response
200 response Modified
- results property Modified

GET /v1/Policies/{Sid}

Response
200 response Modified
- requirements property Modified

GET /v1/SupportingDocumentTypes

Response
200 response Modified
- supporting_document_types property Modified

GET /v1/SupportingDocumentTypes/{Sid}

Response
200 response Modified
- fields property Modified

GET /v1/SupportingDocuments

Response
200 response Modified
- results property Modified

GET /v1/SupportingDocuments/{Sid}

Response
200 response Modified
- attributes property Modified

GET /v1/TrustProducts/{TrustProductSid}/Evaluations

Response
200 response Modified
- results property Modified

GET /v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid}

Response
200 response Modified
- results property Modified

POST /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations

Response
201 response Modified
- results property Modified

POST /v1/EndUsers

Body
content type Modified
- Attributes property Modified
Response
201 response Modified
- attributes property Modified

POST /v1/EndUsers/{Sid}

Body
content type Modified
- Attributes property Modified
Response
200 response Modified
- attributes property Modified

POST /v1/SupportingDocuments

Body
content type Modified
- Attributes property Modified
Response
201 response Modified
- attributes property Modified

POST /v1/SupportingDocuments/{Sid}

Body
content type Modified
- Attributes property Modified
Response
200 response Modified
- attributes property Modified

POST /v1/TrustProducts/{TrustProductSid}/Evaluations

Response
201 response Modified
- results property Modified

Apr 19, 2021

Change #8d3e053d

1.13.0

Compare

Do not miss any Trusthub API changes, ever again

Changelog

API structure has changed

API structure has changed

API documentation has been created