Effortless customer verification now available   View changelog →
Sphere Paysphere
Business Representative

Update a Business Representative

Update an existing business representative

PATCH
/v2/business-representative/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Business Representative ID

Length1 <= length

Request Body

address?object

The address of the business representative. Required if personalInformation is provided.

personalInformation?object

Personal information including tax identification details for individual customers. When any tax identification field is provided, all tax identification fields (number, type, country) and address are required. Please refer to the Individual Verification Criteria for the full list of reference.

representationDetails?object

The representation details of the business representative.

Response Body

curl -X PATCH "https://api.spherepay.co/v2/business-representative/associatedPerson_66c4168d418a410eae282b83883bdc39" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "id": "associatedPerson_66c4168d418a410eae282b83883bdc39",
  "customerId": "customer_66c4168d418a410eae282b83883bdc39",
  "type": "individual",
  "email": "business@example.com",
  "phone": "+1234567890",
  "address": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "city": "Chicago",
    "state": "IL",
    "postalCode": "10001",
    "country": "USA"
  },
  "representationDetails": {
    "roles": [
      "ubo"
    ],
    "ownershipPercentage": "50",
    "isControlPerson": true,
    "isSigner": true,
    "relationshipEstablishedAt": "2020-01-01",
    "title": "CEO"
  },
  "verificationProfiles": [
    {
      "name": "kyc_profile_a",
      "status": "incomplete",
      "criteria": {
        "complete": [
          "email_address",
          "phone_number",
          "residential_address",
          "tax_identification_number"
        ],
        "pending": [
          "email_verification",
          "phone_verification",
          "identity_document",
          "liveness_check",
          "identity_verification"
        ],
        "required": [
          "terms_of_service",
          "email_verification",
          "phone_verification",
          "identity_document",
          "liveness_check",
          "identity_verification"
        ],
        "errors": [
          {
            "name": "email_address",
            "detail": "Email address is required."
          }
        ]
      }
    }
  ],
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

{
  "status": 400,
  "detail": "Invalid request parameters",
  "code": "address/invalid",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 404,
  "detail": "Resource not found",
  "code": "resource/not-found",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 422,
  "detail": "Validation failed",
  "code": "validation/failed",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
  "errors": [
    {
      "detail": "Invalid email format",
      "pointer": "/email"
    },
    {
      "detail": "Name is required",
      "pointer": "/name"
    }
  ]
}