Submit a UBO Declaration

PUT

/v2.01/:ClientId/users/:UserId/kyc/ubodeclarations/:UboDeclarationId

PUT

/v2.01/:ClientId/users/:UserId/kyc/ubodeclarations/:UboDeclarationId

curl -X PUT https://api.sandbox.mangopay.com/v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations/{UboDeclarationId} \
     -H "Authorization: Bearer <token>"

200Updated

{
  "Id": "158947737",
  "UserId": "158947634",
  "CreationDate": 1672153298,
  "ProcessedDate": null,
  "Status": "VALIDATION_ASKED",
  "Reason": null,
  "Message": null,
  "Ubos": [
    {
      "Address": {
        "AddressLine1": "669 Ratke Forge",
        "AddressLine2": "Schamberger Walk",
        "City": "Paris",
        "Country": "FR",
        "PostalCode": "75001",
        "Region": "Île-de-France"
      },
      "Birthday": 652117514,
      "Birthplace": {
        "City": "Paris",
        "Country": "FR"
      },
      "CreationDate": 1672153693,
      "FirstName": "Jess",
      "Id": "158947898",
      "IsActive": true,
      "LastName": "Wiza",
      "Nationality": "FR"
    }
  ]
}

Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution

Mangopay’s hosted KYC/KYB solution is becoming mandatory for all platforms, and allows Legal Users to declare and verify all beneficial owners in the same IDV Session object.

The criteria defining beneficial owners remain the same.

Submitting a UBO Declaration consists in updating the object Status parameter value to VALIDATION_ASKED.

From there, Mangopay Compliance team will validate, indicate as incomplete, or reject the declaration.

<Warning icon="fa-regular fa-triangle-exclamation"> **Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution** Mangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms, and allows Legal Users to declare and verify all beneficial owners in the same [IDV Session](/api-reference/idv-sessions/idv-session-object) object. The [criteria defining beneficial owners](/guides/glossary#beneficial-owner-ubo) remain the same. </Warning> Submitting a UBO Declaration consists in updating the object `Status` parameter value to `VALIDATION_ASKED`. From there, Mangopay Compliance team will validate, indicate as incomplete, or reject the declaration.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

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

UserIdstringRequired

The unique identifier of the user.

UboDeclarationIdstringRequired

The unique identifier of the UBO Declaration.

Request

This endpoint expects an object.

StatusstringRequired

Allowed values: VALIDATION_ASKED

The status of the dispute document.

Response

Success

IdstringOptional

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

The unique identifier of the object.

UserIdstringOptional

The unique identifier of the user.

CreationDateintegerOptional

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

ProcessedDateintegerOptional

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

StatusstringOptional

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.

ReasonstringOptional

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

MessagestringOptional

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

Uboslist of objectsOptional

The list of UBOs attached to the UBO Declaration.