AdyenClient.LegalEntity (AdyenClient v1.0.0)

Copy Markdown View Source

Adyen Legal Entity Management API (v4).

Handles KYC onboarding: legal entities, transfer instruments, business lines, documents, Terms of Service, PCI questionnaires, and hosted onboarding links.

Summary

Functions

accept_tos(id, tos_doc_id, params, opts \\ [])

Accept Terms of Service.

calculate_pci_status(id, params, opts \\ [])

Calculate PCI status.

check_tax_edelivery_consent(id, params, opts \\ [])

Check tax e-delivery consent status.

check_verification_errors(id, opts \\ [])

Check verification errors for a legal entity.

confirm_data_review(id, opts \\ [])

Confirm data review for a legal entity.

create(params, opts \\ [])

Create a legal entity.

create_business_line(params, opts \\ [])

Create a business line.

create_transfer_instrument(params, opts \\ [])

Create a transfer instrument (bank account).

delete_business_line(id, opts \\ [])

Delete a business line.

delete_document(id, opts \\ [])

Delete a document.

delete_transfer_instrument(id, opts \\ [])

Delete a transfer instrument.

generate_pci_questionnaire(id, params, opts \\ [])

Generate a PCI questionnaire.

get(id, opts \\ [])

Get a legal entity.

get_accepted_tos_document(id, acceptance_ref, opts \\ [])

Get the accepted Terms of Service document.

get_business_line(id, opts \\ [])

Get a business line.

get_business_lines(id, opts \\ [])

Get all business lines under a legal entity.

get_document(id, opts \\ [])

Get a document.

get_onboarding_link(id, params, opts \\ [])

Get a link to an Adyen-hosted onboarding page.

get_onboarding_theme(theme_id, opts \\ [])

Get a specific onboarding theme.

get_pci_questionnaire(id, pci_id, opts \\ [])

Get a specific PCI questionnaire.

get_pci_questionnaires(id, opts \\ [])

Get PCI questionnaire details.

get_tos(id, params, opts \\ [])

Get the Terms of Service document for a legal entity.

get_tos_acceptance_info(id, opts \\ [])

Get ToS acceptance info for a legal entity.

get_tos_status(id, opts \\ [])

Get Terms of Service status.

get_transfer_instrument(id, opts \\ [])

Get a transfer instrument.

list_onboarding_themes(opts \\ [])

List hosted onboarding page themes.

request_periodic_review(id, opts \\ [])

Request a periodic data review.

set_tax_edelivery_consent(id, params, opts \\ [])

Set tax e-delivery consent.

sign_pci_questionnaire(id, params, opts \\ [])

Sign a PCI questionnaire.

update(id, params, opts \\ [])

Update a legal entity.

update_business_line(id, params, opts \\ [])

Update a business line.

update_document(id, params, opts \\ [])

Update a document.

update_transfer_instrument(id, params, opts \\ [])

Update a transfer instrument.

upload_document(params, opts \\ [])

Upload a document for verification.

Functions

accept_tos(id, tos_doc_id, params, opts \\ [])

@spec accept_tos(String.t(), String.t(), map(), keyword()) ::
  AdyenClient.Client.response()

Accept Terms of Service.

calculate_pci_status(id, params, opts \\ [])

@spec calculate_pci_status(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()

Calculate PCI status.

check_tax_edelivery_consent(id, params, opts \\ [])

@spec check_tax_edelivery_consent(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()

Check tax e-delivery consent status.

check_verification_errors(id, opts \\ [])

@spec check_verification_errors(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Check verification errors for a legal entity.

confirm_data_review(id, opts \\ [])

@spec confirm_data_review(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Confirm data review for a legal entity.

create(params, opts \\ [])

@spec create(
  map(),
  keyword()
) :: AdyenClient.Client.response()

Create a legal entity.

create_business_line(params, opts \\ [])

@spec create_business_line(
  map(),
  keyword()
) :: AdyenClient.Client.response()

Create a business line.

create_transfer_instrument(params, opts \\ [])

@spec create_transfer_instrument(
  map(),
  keyword()
) :: AdyenClient.Client.response()

Create a transfer instrument (bank account).

delete_business_line(id, opts \\ [])

@spec delete_business_line(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Delete a business line.

delete_document(id, opts \\ [])

@spec delete_document(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Delete a document.

delete_transfer_instrument(id, opts \\ [])

@spec delete_transfer_instrument(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Delete a transfer instrument.

generate_pci_questionnaire(id, params, opts \\ [])

@spec generate_pci_questionnaire(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()

Generate a PCI questionnaire.

get(id, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Get a legal entity.

get_accepted_tos_document(id, acceptance_ref, opts \\ [])

@spec get_accepted_tos_document(String.t(), String.t(), keyword()) ::
  AdyenClient.Client.response()

Get the accepted Terms of Service document.

get_business_line(id, opts \\ [])

@spec get_business_line(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Get a business line.

get_business_lines(id, opts \\ [])

@spec get_business_lines(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Get all business lines under a legal entity.

get_document(id, opts \\ [])

@spec get_document(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Get a document.

get_onboarding_link(id, params, opts \\ [])

@spec get_onboarding_link(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()

Get a link to an Adyen-hosted onboarding page.

get_onboarding_theme(theme_id, opts \\ [])

@spec get_onboarding_theme(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Get a specific onboarding theme.

get_pci_questionnaire(id, pci_id, opts \\ [])

@spec get_pci_questionnaire(String.t(), String.t(), keyword()) ::
  AdyenClient.Client.response()

Get a specific PCI questionnaire.

get_pci_questionnaires(id, opts \\ [])

@spec get_pci_questionnaires(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Get PCI questionnaire details.

get_tos(id, params, opts \\ [])

@spec get_tos(String.t(), map(), keyword()) :: AdyenClient.Client.response()

Get the Terms of Service document for a legal entity.

get_tos_acceptance_info(id, opts \\ [])

@spec get_tos_acceptance_info(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Get ToS acceptance info for a legal entity.

get_tos_status(id, opts \\ [])

@spec get_tos_status(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Get Terms of Service status.

get_transfer_instrument(id, opts \\ [])

@spec get_transfer_instrument(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Get a transfer instrument.

list_onboarding_themes(opts \\ [])

@spec list_onboarding_themes(keyword()) :: AdyenClient.Client.response()

List hosted onboarding page themes.

request_periodic_review(id, opts \\ [])

@spec request_periodic_review(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()

Request a periodic data review.

set_tax_edelivery_consent(id, params, opts \\ [])

@spec set_tax_edelivery_consent(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()

Set tax e-delivery consent.

sign_pci_questionnaire(id, params, opts \\ [])

@spec sign_pci_questionnaire(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()

Sign a PCI questionnaire.

update(id, params, opts \\ [])

@spec update(String.t(), map(), keyword()) :: AdyenClient.Client.response()

Update a legal entity.

update_business_line(id, params, opts \\ [])

@spec update_business_line(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()

Update a business line.

update_document(id, params, opts \\ [])

@spec update_document(String.t(), map(), keyword()) :: AdyenClient.Client.response()

Update a document.

update_transfer_instrument(id, params, opts \\ [])

@spec update_transfer_instrument(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()

Update a transfer instrument.

upload_document(params, opts \\ [])

@spec upload_document(
  map(),
  keyword()
) :: AdyenClient.Client.response()

Upload a document for verification.