Credit records (1.0)

Download OpenAPI specification:Download

Person credit record

Create a credit record for a retail customer

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.

Request
Security:
path Parameters
person_id
required
string

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

Request Body schema: application/json

The credit record attributes

source
required
string

The source of the credit record file.

Enum: "partner" "solarisBank"
file
string or null

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

Responses
201

CreditRecord

400

Bad Request

403

Forbidden

404

Not Found

500

Internal server error

504

Gateway Timeout

post/v1/persons/{person_id}/credit_records
Request samples
application/json
{
  • "source": "solarisBank",
  • "file": "string"
}
Response samples
application/json
{
  • "status": "available",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  • "created_at": "2020-20-03T18:01:48.000Z"
}

Create a credit record for a freelancer

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.

Request
Security:
path Parameters
person_id
required
string

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

Request Body schema: application/json

The credit record attributes

source
required
string

The source of the credit record file.

Enum: "partner" "solarisBank"
file
string or null

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

Responses
201

CreditRecord

400

Bad Request

403

Forbidden

404

Not Found

500

Internal server error

504

Gateway Timeout

post/v1/freelancers/persons/{person_id}/credit_records
Request samples
application/json
{
  • "source": "solarisBank",
  • "file": "string"
}
Response samples
application/json
{
  • "status": "available",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  • "created_at": "2020-20-03T18:01:48.000Z"
}

Retrieve a credit record

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.

Request
Security:
path Parameters
person_id
required
string

The person_id of the customer.

credit_record_id
required
string

The unique ID of the customer's credit record.

Responses
200

Credit Record

404

Not Found

get/v1/persons/{person_id}/credit_records/{credit_record_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_records/{credit_record_id}'
Response samples
application/json
{
  • "status": "available",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  • "created_at": "2020-20-03T18:01:48.000Z"
}