---
title: "GET /badge"
method: GET
path: "/badge"
tags: ["GET"]
---

# GET /badge

`GET /badge`

Retrieve location declaration information from Reach. For more information see [Reach disclaimer and Terms of Service requirements](https://docs.withreach.com/docs/reach-disclaimer-and-terms-of-service-requirements).

## Query parameters

- `MerchantId` string, uuid, required — The 36 character GUID which identifies the supplier to the Reach system.
- `Locale` string — JSONP Javascript function name.
- `Callback` string — JSONP Javascript function name.
- `Currency` string — An upper-case 3 character ISO 4217 currency code.
- `ConsumerIpAddress` union — A valid IP address, v4 or v6.
  - string, ipv4
  - string, ipv6
- `Theme` 'light' | 'dark'

## Response `200`

Either the text or image should be displayed and linked to the  TermsOfServiceUrl.

- object
  - `Text` string, required — The text to display.
  - `Html` string, required — The HTML snippet to display.
  - `ImageUrl` string, uri, required — The image to display.
  - `TermsOfServiceUrl` string, uri, required — The location that the text or image should link to.
  - `MerchantOfRecord` string, required — The name of the entity handling the payment.
  - `MerchantOfRecordUrl` string, uri, required — The location of the Merchant of Record website.
  - `MerchantName` string, required — As a convenience, the name of the supplier associated with the specified MerchantId.
  - `FlagImageUrl` string, required — The flag image associated with the Merchant of Record.

## Other responses

- `400` — If present, the badge request structure was invalid and unable to be parsed.
- `404` — If present, a value of the request was unable to be found. For example, if the MerchantId provided could not be found in the given environment
- `503` — There was a system problem and the request should be tried again.

---

[API](https://skmtc.net/withreach/apis/reach-checkout-api.md) · [All operations](https://skmtc.net/withreach/apis/reach-checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/withreach/reach-checkout-api/versions/f95f4b8dd180/schema)