Skip to main content
GET
/
v1
/
identities
/
{identityId}
/
compliance-checks
/
{slug}
/
requirements
Get compliance requirements for a compliance
curl --request GET \
  --url https://sandbox-api.borderless.xyz/v1/identities/{identityId}/compliance-checks/{slug}/requirements \
  --header 'Authorization: Bearer <token>'
{
  "slug": "compliance-fee5483c",
  "schema": {},
  "missingFields": [
    "<string>"
  ],
  "requiredDocuments": [
    {
      "mode": "oneOf",
      "documents": [
        "Passport"
      ]
    }
  ],
  "requiredExtras": {
    "acceptTermsOfService": {
      "link": "<string>",
      "redirectUrl": "<string>"
    },
    "yellowcardCredentials": {
      "provided": true,
      "valid": true
    },
    "bitsoCredentials": {
      "provided": true,
      "valid": true,
      "status": {
        "current": "<string>",
        "required": "<string>"
      },
      "verificationLevel": {
        "current": 123,
        "minimum": 123
      }
    },
    "hercleCredentials": {
      "provided": true,
      "valid": true
    },
    "finityCredentials": {
      "provided": true,
      "valid": true
    },
    "capaCredentials": {
      "provided": true,
      "valid": true
    }
  },
  "type": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

identityId
string
required
slug
string
required

Query Parameters

redirectUrl
string

Optional redirect URL after compliance check

Response

200 - application/json
slug
enum<string>
required
Available options:
compliance-fee5483c,
compliance-3d0947c0,
compliance-9f5059c4,
compliance-4a8e9f3b,
compliance-7b9d2c6a,
compliance-de8e1920,
compliance-t7f4b831,
compliance-h9x7p245,
compliance-432704,
compliance-15bc9ec4,
compliance-a96ad46a,
compliance-4c347d0a,
compliance-ff6f0b66,
compliance-bbd0abdf,
compliance-d4a0bea2,
compliance-ce1ef04d,
compliance-191335b3,
compliance-f47aa1e0,
compliance-b92f0ad3
schema
object
required
missingFields
string[]
required
requiredDocuments
object[]
required
requiredExtras
object
required
type
object
required