POST [/instances/$INSTANCE]/private/accounts/$H_WIRE/kycauth

Request from the backend to create wire transfer instructions for a KYC Auth transfer for a particular bank account and exchange.

KYC Auth transfers may be required by an exchange when an account is activated for the first time. Furthermore, obtaining the correct wire transfer instructions may require getting details from the exchange and interacting with the banking system to produce a proper (short) wire transfer subject and a transferrable minimum amount. Thus, this endpoint should be used to obtain the wire transfer instructions for a KYC Auth wire transfer when onboarding a new bank account at an exchange that requires proof of control over the bank account via a wire transfer.

Since protocol v28.

Required permission: accounts-read

Request:

The request must provide exchange information.

Response:

200 Ok:

Wire transfer instructions are returned in the response.

404 Not found:

The instance or account are unknown to the exchange.

Details:

interface KycAuthExchangeSelectionRequest {

  // Base URL of the exchange for which KYC Auth wire
  // transfer instructions are requested.
  exchange_url: string;
}

interface KycAuthWireTransferInstructionResponse {

  // Array of possible wire transfers to do. There might
  // be more than one possibility, for example if the
  // exchange supports multiple bank accounts.
  wire_instructions: WireTransferInstructionDetail[];

}

interface WireTransferInstructionDetail {

  // Amount to wire (minimum amount, as per tiny_amount
  // of the /keys of the exchange).
  amount: Amount;

  // Full payto:// URL of the (exchange) bank account to which the
  // money should be sent, excludes the wire subject and the amount.
  target_payto: string;

  // Subject to use. See also DD80!
  subject: TransferSubject;

  // Expiration date after which this subject might be reused
  expiration: Timestamp;

}