GoCardless Verification Details API.
Submit KYC/KYB information for creditor verification. GoCardless uses this to verify your business before enabling live payments.
Example
{:ok, detail} = GoCardlessClient.Resources.VerificationDetails.create(client, %{
name_on_account: "Acme Ltd",
address_line1: "1 Example Street",
city: "London",
postal_code: "EC1A 1BB",
country_code: "GB",
description: "B2B SaaS subscription management platform",
directors: [
%{
given_name: "Alice",
family_name: "Smith",
date_of_birth: "1985-06-15",
country_of_nationality: "GB"
}
],
links: %{creditor: "CR123"}
})Summary
Functions
@spec collect_all(GoCardlessClient.Client.t(), map(), keyword()) :: {:ok, [map()]} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Eagerly collects all verification details into a list.
@spec create(GoCardlessClient.Client.t(), map(), keyword()) :: {:ok, map()} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Submits KYC/KYB verification details for a creditor.
Params
:name_on_account— business name as it appears on the bank account (required):address_line1— business address (required):city— city (required):postal_code— postcode/ZIP (required):country_code— ISO 3166-1 alpha-2 (required):description— brief description of your business (required):directors— list of director objects (each requiresgiven_name,family_name,date_of_birth,country_of_nationality)links.creditor— Creditor ID (required)
@spec get(GoCardlessClient.Client.t(), String.t(), keyword()) :: {:ok, map()} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Retrieves a single verification detail record by ID.
@spec list(GoCardlessClient.Client.t(), map(), keyword()) :: {:ok, %{items: [map()], meta: map()}} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Returns a page of verification details. Filter by :creditor.
@spec stream(GoCardlessClient.Client.t(), map(), keyword()) :: Enumerable.t()
Returns a lazy Stream over all pages of verification details.