uboDeclarations

View a UBO Declaration

Changed on

View a UBO Declaration

Read more about the UBO Declaration object →

get/v2.01/{ClientId}/kyc/ubodeclarations/{UboDeclarationId}

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/kyc/ubodeclarations/{UboDeclarationId}
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

UboDeclarationIdstring required

The unique identifier of the UBO Declaration.

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

UserIdstring

The unique identifier of the user.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

ProcessedDateinteger

Unix timestamp (UTC) of the date and time the UBO Declaration was processed by Mangopay's team.

Statusstring

Returned values: CREATED, VALIDATION_ASKED, INCOMPLETE, VALIDATED, REFUSED

The status of the declaration:

  • CREATED – The UBO Declaration is created, but not submitted yet.
  • VALIDATION_ASKED – The UBO Declaration is submitted for validation.
  • INCOMPLETE – The UBO Declaration is deemed incomplete by Mangopay teams.
  • VALIDATED – The UBO Declaration is validated by Mangopay's team.
  • REFUSED – The UBO Declaration is rejected by Mangopay's team. You can learn more about the reasons for refusal in the Reason and  Message fields.
Reasonstring

The reason for which the UBO Declaration was REFUSED or considered as INCOMPLETE.

Messagestring

Additional information about why the UBO Declaration was refused or marked as incomplete, provided by Mangopay's team.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id view_ubo_declaration removed and replaced with uboDeclarations_view_ubo_declaration