SEP-12SEP-31SEP-6

Retrieve Customer's Info

GET 
/customer

The request and response for this endpoint is identical to the GET /customer request and response defined in SEP-12.

This endpoint allows clients to:

1. Fetch the fields the server requires in order to register a new customer via a SEP-12 PUT /customer request

If the server does not have a customer registered for the parameters sent in the request, it should return the fields required in the response. The same response should be returned when no parameters are sent.

2. Check the status of a customer that may already be registered

This allows clients to check whether the customers information was accepted, rejected, or still needs more info. If the server still needs more info, or the server needs updated information, it should return the fields required.

Request

Query Parameters

id string

The ID of the customer as returned in the response of a previous PUT request.

account string

The Stellar or Muxed Account authenticated with the Platform via SEP-10.

memo string

The memo value identifying a customer with a shared account, where the shared account is account.

memo_type string

Possible values: [id, hash, text]

The type of memo used to identify a customer with a shared account.

type string

The type of action the customer is being KYCd for. See the Type Specification documented in SEP-12.

transaction_id string

The transaction id with which the customer's info is associated. When information from the customer depends on the transaction (e.g., more information is required for larger amounts)

lang string

Defaults to en. Language code specified using ISO 639-1. Human readable descriptions, choices, and messages should be in this language.

Responses

200

Valid request. Customer either already exists or the customer identified by the parameters is new and must provide the field values described in the response body. Response bodies are identical to the schema defined in SEP-12.

application/json

Schema

Schema

id string
status stringrequired

Possible values: [ACCEPTED, PROCESSING, NEEDS_INFO, REJECTED]

fields

object

property name*

type stringrequired

Possible values: [string, binary, number, date]

description stringrequired

choices string[]

optional boolean

provided_fields

object

property name*

type stringrequired

Possible values: [string, binary, number, date]

description stringrequired

choices string[]

optional boolean

status string

Possible values: [ACCEPTED, PROCESSING, REJECTED, VERIFICATION_REQUIRED]

error string
message string

Example (from schema)

{
  "id": "string",
  "status": "ACCEPTED",
  "fields": {},
  "provided_fields": {},
  "message": "string"
}

SuccessKYC

{
  "id": "d1ce2f48-3ff1-495d-9240-7a50d806cfed",
  "status": "ACCEPTED",
  "provided_fields": {
    "first_name": {
      "description": "The customer's first name",
      "type": "string",
      "status": "ACCEPTED"
    },
    "last_name": {
      "description": "The customer's last name",
      "type": "string",
      "status": "ACCEPTED"
    },
    "email_address": {
      "description": "The customer's email address",
      "type": "string",
      "status": "ACCEPTED"
    }
  }
}

400

Error.

application/json

Schema

Schema

error stringrequired
id string

Example (from schema)

{
  "error": "string",
  "id": "string"
}

404

Not Found.

application/json

Schema

Schema

error stringrequired
id string

Example (from schema)

{
  "error": "string",
  "id": "string"
}

Loading...