Skip to content
/Person credit record

Credit records (1.0)

Download OpenAPI description
credit-record.json
credit-record.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/lending/credit-record/

Person credit record

Operations

Create a credit record for a retail customer

Request

Creates a credit record and assigns to the customer with the person_id specified in the request URL. You can specify the source of the credit record file as either partner or solarisBank. If the source is set to partner, you must collect the credit record yourself from a credit bureau and add the credit record file content Base64-encoded in the payload.

Path
person_idstringrequired

The person ID of the customer for whom you are creating the credit record.

Bodyapplication/json

The credit record attributes

sourcestringrequired

The source of the credit record file.

Enum"partner""solarisBank"
Example: "solarisBank"
filestring or null

The credit record file content, Base64-encoded. Required only if source is partner.

application/json
{
  "source": "solarisBank",
  "file": "string"
}

Responses

CreditRecord

Bodyapplication/json
idstringrequired

The ID of the credit record resource.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
person_idstringrequired

The person ID of the customer.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of the credit record. If the status is expired, you must create a new credit record for the customer.

Enum"available""expired"
Example: "available"
created_atstringrequired

UTC timestamp from when the credit record was created.

Example: "2020-20-03T18:01:48.000Z"
Response
application/json
{
  "status": "available",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2020-20-03T18:01:48.000Z"
}

Create a credit record for a freelancer

Request

Creates a credit record and assigns to the freelancer with the person_id specified in the request URL. You can specify the source of the credit record file as either partner or solarisBank. If the source is set to partner, you must collect the credit record yourself from a credit bureau and add the credit record file content Base64-encoded in the payload.

Path
person_idstringrequired

The person ID of the freelancer for whom you are creating the credit record.

Bodyapplication/json

The credit record attributes

sourcestringrequired

The source of the credit record file.

Enum"partner""solarisBank"
Example: "solarisBank"
filestring or null

The credit record file content, Base64-encoded. Required only if source is partner.

application/json
{
  "source": "solarisBank",
  "file": "string"
}

Responses

CreditRecord

Bodyapplication/json
idstringrequired

The ID of the credit record resource.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
person_idstringrequired

The person ID of the customer.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of the credit record. If the status is expired, you must create a new credit record for the customer.

Enum"available""expired"
Example: "available"
created_atstringrequired

UTC timestamp from when the credit record was created.

Example: "2020-20-03T18:01:48.000Z"
Response
application/json
{
  "status": "available",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2020-20-03T18:01:48.000Z"
}

Retrieve a credit record

Request

Returns the information about a customer's existing credit record, including the status and validity of the credit record. Add the customer's person_id and the credit_record_id in the request URL. If the status of a credit record is expired, you must create a new credit record for the customer.

Path
person_idstringrequired

The person_id of the customer.

credit_record_idstringrequired

The unique ID of the customer's credit record.

No request payload

Responses

Credit Record

Bodyapplication/json
idstringrequired

The ID of the credit record resource.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
person_idstringrequired

The person ID of the customer.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of the credit record. If the status is expired, you must create a new credit record for the customer.

Enum"available""expired"
Example: "available"
created_atstringrequired

UTC timestamp from when the credit record was created.

Example: "2020-20-03T18:01:48.000Z"
Response
application/json
{
  "status": "available",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2020-20-03T18:01:48.000Z"
}