Business fronting

Retrieve the details of the business relationship with a customer

Returns the details of an existing business relationship with the customer with the business_id specified in the request URL. Additionally, subscribe to the webhook event BUSINESS_FRONTING_RELATIONSHIP_STATUS_CHANGED to receive status updates about changes to the business relationship.

get/v1/businesses/{business_id}/fronting_loans_business_relationship

Path parameters

business_idstring required

The ID of the business.

Response

Business relationship

business_idstring required

The ID of the business.

created_atstring datetime required

The date when the business relationship was created.

offboarded_atstring datetime nullable

The date when the business was off-boarded.

status'active' | 'closed' | 'blocked' required

The status of the business relationship.

status_reasonstring nullable

Additional context about the reasons for a particular status.

updated_atstring datetime required

The date when the business relationship was last updated.

Example response

{
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "created_at": "2020-20-03T18:01:48.000Z",
  "offboarded_at": "2022-20-03T18:01:48.000Z",
  "status": "closed",
  "status_reason": "offboarded_by_partner",
  "updated_at": "2021-20-03T18:01:48.000Z"
}