Skip to main content
PUT
/
customers
/
{id}
Update Customer
curl --request PUT \
  --url https://api.sandbox.sudo.cards/customers/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "individual",
  "name": "<string>",
  "phoneNumber": "<string>",
  "emailAddress": "<string>",
  "individual": {
    "firstName": "<string>",
    "lastName": "<string>",
    "otherNames": "<string>",
    "dob": "<string>",
    "identity": {
      "type": "BVN",
      "number": "<string>"
    },
    "documents": {
      "idFrontUrl": "<string>",
      "idBackUrl": "<string>",
      "incorporationCertificateUrl": "<string>",
      "addressVerificationUrl": "<string>"
    }
  },
  "company": {
    "name": "<string>",
    "identity": {
      "type": "BVN",
      "number": "<string>"
    },
    "officer": {
      "firstName": "<string>",
      "lastName": "<string>",
      "otherNames": "<string>",
      "dob": "<string>",
      "identity": {
        "type": "BVN",
        "number": "<string>"
      },
      "documents": {
        "idFrontUrl": "<string>",
        "idBackUrl": "<string>",
        "incorporationCertificateUrl": "<string>",
        "addressVerificationUrl": "<string>"
      }
    },
    "documents": {
      "idFrontUrl": "<string>",
      "idBackUrl": "<string>",
      "incorporationCertificateUrl": "<string>",
      "addressVerificationUrl": "<string>"
    }
  },
  "status": "active",
  "metadata": "<string>",
  "billingAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  }
}'
"{}"

Authorizations

​
Authorization
string
header
default:{{APIKey}}
required

Path Parameters

​
id
string
required

The _id of the customer you wish to update.

Body

application/json
​
type
enum<string>
default:individual
required

This is the customer type.

Available options:
individual,
company
​
name
string
required

The customer's full name.

​
status
enum<string>
default:active
required

This is the status of the customer.

Available options:
active,
inactive
​
phoneNumber
string

Customer's mobile phone number in international format.

​
emailAddress
string

Customer's email address.

​
individual
object

Individual details. Required if customer type is individual.

​
company
object

Company details. Required if customer type is company.

​
metadata
string<json>

The customer metadata object in key-value pair. This can be useful for storing additional information about the customer in a structured format

​
billingAddress
object

This is the billing address of the customer.

Response

200

The response is of type object.