Saltar al contenido principal
Versión: 3.0.0
SEP-12SEP-24SEP-31SEP-6

Create or Update Customer Info

PUT 
/customer

The Anchor Platform does not persist any customer KYC data.

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

Client applications make requests with the following request body, which is forwarded to the anchor. Anchors must validate and persist the data passed, and return the customer's id. Requests containing only string fields will be forwarded to the anchor as with the application/json content type. Requests containing binary fields will be forwarded to the anchor as with the multipart/form-data content type.

Request​

Body

    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 for more info. For SEP-31 you can define your own types in the assets configuration. For SEP-24 pre-defined value sep24-customer is used.

    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)

    first_name string
    last_name string
    additional_name string
    address_country_code string
    state_or_province string
    city string
    postal_code string
    address string
    mobile_number string
    email_address string
    birth_date date
    birth_place string
    birth_country_code string
    bank_name string
    bank_account_number string
    bank_account_type string
    bank_number string
    bank_phone_number string
    bank_branch_number string
    external_transfer_memo string
    clabe_number string
    cbu_alias string
    mobile_money_number string
    mobile_money_provider string
    crypto_address string
    crypto_memo string

    Deprecated. Use external_transfer_memo instead.

    tax_id string
    tax_id_name string
    occupation string
    employer_name string
    employer_address string
    language_code string
    id_type string
    id_country_code string
    id_issue_date date
    id_expiration_date date
    id_number string
    ip_address string
    sex string
    referral_id string
    mobile_number_verification string
    email_address_verification string

Responses​

Success.

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
Loading...