Get the business profile

GET

/merchant/business-profile

const url = 'https://sandbox.partners.loops.sa/v1/merchant/business-profile';
const options = {
  method: 'GET',
  headers: {'Loops-Merchant-Id': 'mer_7Hq2Lw8Z', Authorization: 'Bearer <token>'}
};

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

curl --request GET \
  --url https://sandbox.partners.loops.sa/v1/merchant/business-profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Loops-Merchant-Id: mer_7Hq2Lw8Z'

The merchant’s legal details, uploaded documents and review status.

Authorizations

bearerAuth
merchant:read

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.

Responses

200

The business profile.

application/json

object

merchant_id

required

string

status

required

draft: being filled in. in_review: submitted, Loops is reviewing it. approved: locations can go live on delivery apps. rejected: fix what the review says and submit again.

string

Allowed values: draft in_review approved rejected

details

One of:

object
null

object

legal_name

required

As on the commercial registration.

string

cr_number

required

Commercial registration number, 10 digits.

string

/^[0-9]{10}$/

vat_number

required

VAT registration number, 15 digits starting and ending with 3.

string

/^3[0-9]{13}3$/

national_address

required

The Saudi national address, as on the national address certificate.

object

building_number

required

string

/^[0-9]{4}$/

street

required

string

district

required

string

city

required

string

postal_code

required

string

/^[0-9]{5}$/

additional_number

required

string

/^[0-9]{4}$/

documents

required

Array<object>

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

required_documents

required

Document types needed before you can submit. Loops sets this per merchant.

Array<string>

Allowed values: commercial_registration vat_certificate national_address_certificate iban_certificate owner_id

review

object

submitted_at

string | null format: date-time

reviewed_at

string | null format: date-time

notes

What to fix, when the profile is rejected.

string | null

Example

{
  "status": "draft",
  "details": {
    "legal_name": "شركة المذاق الأصيل للوجبات السريعة",
    "cr_number": "1010123456",
    "vat_number": "310123456700003",
    "national_address": {
      "building_number": "7421",
      "street": "Prince Turki Street",
      "district": "Al Olaya",
      "city": "Riyadh",
      "postal_code": "12214",
      "additional_number": "3156"
    }
  },
  "documents": [
    {
      "id": "doc_3Hn8Wq",
      "type": "commercial_registration",
      "status": "pending",
      "file_name": "cr-certificate.pdf",
      "rejection_reason": "The certificate has expired. Upload the current one."
    }
  ],
  "required_documents": [
    "commercial_registration",
    "vat_certificate",
    "national_address_certificate",
    "iban_certificate"
  ]
}

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

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."
    }
  ]
}

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."
    }
  ]
}