Upload a document

POST

/merchant/business-profile/documents

const url = 'https://sandbox.partners.loops.sa/v1/merchant/business-profile/documents';
const form = new FormData();
form.append('type', 'commercial_registration');
form.append('file', 'file');

const options = {
  method: 'POST',
  headers: {
    'Loops-Merchant-Id': 'mer_7Hq2Lw8Z',
    'Idempotency-Key': '6f1c2a9e-3b7d-4c55-9a40-2d8e1f7b9c31',
    Authorization: 'Bearer <token>'
  }
};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://sandbox.partners.loops.sa/v1/merchant/business-profile/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'Idempotency-Key: 6f1c2a9e-3b7d-4c55-9a40-2d8e1f7b9c31' \
  --header 'Loops-Merchant-Id: mer_7Hq2Lw8Z' \
  --form type=commercial_registration \
  --form file=@file

Uploads one document for the business profile, as PDF, JPG or PNG, up to 4 MB. Uploading a type that already exists replaces the previous file. Allowed while the profile is draft or rejected.

Authorizations

bearerAuth
merchant:write

Parameters

Header Parameters

Loops-Merchant-Id

string

The merchant you are acting for (mer_…). Required for platform applications; optional for direct integrations, which have a single merchant.

Idempotency-Key

string

A unique value (a UUID) for this request. If you retry with the same key within 24 hours, you get the original response instead of a second change.

Request Body^required

multipart/form-data

object

type

required

The kind of document.

string

Allowed values: commercial_registration vat_certificate national_address_certificate iban_certificate owner_id

file

required

PDF, JPG or PNG, up to 4 MB.

string format: binary

Responses

201

The uploaded document.

application/json

object

required

string

type

required

The kind of document.

string

Allowed values: commercial_registration vat_certificate national_address_certificate iban_certificate owner_id

status

required

Set by the review. pending until Loops reviews it.

string

Allowed values: pending accepted rejected

file_name

required

string

rejection_reason

string | null

uploaded_at

required

string format: date-time

Example

{
  "id": "doc_3Hn8Wq",
  "type": "commercial_registration",
  "status": "pending",
  "file_name": "cr-certificate.pdf",
  "rejection_reason": "The certificate has expired. Upload the current one."
}

400

The request is invalid. errors lists each problem.

application/problem+json

RFC 9457 Problem Details with a stable code.

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine-readable error code. Switch on this, not on title.

string

Allowed values: invalid_request invalid_file merchant_required unauthorized insufficient_scope scope_not_granted connection_not_active application_suspended not_found merchant_not_found merchant_exists external_ref_conflict business_profile_locked idempotency_key_reused rate_limited upstream_unavailable

detail

string

request_id

required

string

existing_id

For external_ref_conflict, the ID of the object that already uses the reference.

string

errors

Field errors, for invalid_request.

Array<object>

object

field

string

message

string

Example

{
  "type": "https://docs.partners.loops.sa/errors/external_ref_conflict",
  "title": "External reference already used",
  "status": 409,
  "code": "invalid_request",
  "detail": "A location with external_ref BR-01 already exists.",
  "request_id": "req_01J9X7P2QK",
  "existing_id": "loc_2Xf9K",
  "errors": [
    {
      "field": "products[3].price",
      "message": "Required unless the product has variants."
    }
  ]
}

401

The access token is missing, expired or invalid.

application/problem+json

RFC 9457 Problem Details with a stable code.

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine-readable error code. Switch on this, not on title.

string

detail

string

request_id

required

string

existing_id

For external_ref_conflict, the ID of the object that already uses the reference.

string

errors

Field errors, for invalid_request.

Array<object>

object

field

string

message

string

Example

{
  "type": "https://docs.partners.loops.sa/errors/external_ref_conflict",
  "title": "External reference already used",
  "status": 409,
  "code": "invalid_request",
  "detail": "A location with external_ref BR-01 already exists.",
  "request_id": "req_01J9X7P2QK",
  "existing_id": "loc_2Xf9K",
  "errors": [
    {
      "field": "products[3].price",
      "message": "Required unless the product has variants."
    }
  ]
}

403

Not allowed: the scope isn’t approved or granted, the connection is not active, or your application is suspended. See code.

application/problem+json

RFC 9457 Problem Details with a stable code.

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine-readable error code. Switch on this, not on title.

string

detail

string

request_id

required

string

existing_id

For external_ref_conflict, the ID of the object that already uses the reference.

string

errors

Field errors, for invalid_request.

Array<object>

object

field

string

message

string

Example

{
  "type": "https://docs.partners.loops.sa/errors/external_ref_conflict",
  "title": "External reference already used",
  "status": 409,
  "code": "invalid_request",
  "detail": "A location with external_ref BR-01 already exists.",
  "request_id": "req_01J9X7P2QK",
  "existing_id": "loc_2Xf9K",
  "errors": [
    {
      "field": "products[3].price",
      "message": "Required unless the product has variants."
    }
  ]
}

409

The request conflicts with the current state, for example an external_ref already in use, or a business profile that is in review. See code.

application/problem+json

RFC 9457 Problem Details with a stable code.

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine-readable error code. Switch on this, not on title.

string

detail

string

request_id

required

string

existing_id

For external_ref_conflict, the ID of the object that already uses the reference.

string

errors

Field errors, for invalid_request.

Array<object>

object

field

string

message

string

Example

{
  "type": "https://docs.partners.loops.sa/errors/external_ref_conflict",
  "title": "External reference already used",
  "status": 409,
  "code": "invalid_request",
  "detail": "A location with external_ref BR-01 already exists.",
  "request_id": "req_01J9X7P2QK",
  "existing_id": "loc_2Xf9K",
  "errors": [
    {
      "field": "products[3].price",
      "message": "Required unless the product has variants."
    }
  ]
}

Upload a document

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

201

Example

400

Example

401

Example

403

Example

409

Example

Request Body^required