This page explains how to query the signers of an account and how to follow the request to add a new signer. The inclusion itself is done in Adding Signers, and the queries on this page are used to check the result.

Query methods

MethodWhat it is for
GetSignersReturns the signers linked to a company.
GetRequestSignerReturns the status of a request to add a signer made with AddSigner.

The parameters and examples are in the API Reference.

In addition to the fields described below, the request of each method carries Method (the method name), PartnerId and BusinessUnitId, which identify the BU.

In the Requirement column, Mandatory means the field must be sent; Optional, that it can be omitted; Conditional, that it depends on another field, and the condition is in the description.

GetSigners

The method has no AccountKey or HolderTaxNumber, and it does not return the role of the signer or the status of a request. If the company has no signers, the response may come with Success = "true" and empty Owner and Signers.

Request fields

FieldRequirementDescription
TaxNumberMandatoryCNPJ of the holder (the company).

Response fields

Owner and each item of Signers have the same fields, listed below without the prefix. The data varies according to the profile (individual or legal entity).

FieldDescription
Success"true" or "false".
OwnerData of the holder (the company).
SignersSigners linked to the company.
TaxNumberCPF or CNPJ.
NameName or company name.
TradingNameTrade name. Only for legal entities.
NicknameNickname.
MailEmail.
PhonePhone.
FatherNameFather's name.
MotherNameMother's name.
NationalityNationality.
BirthCityCity of birth.
BirthStateState of birth, as a number.
BirthDateDate of birth, in the format yyyy-MM-dd.
GenderGender: 0 Male, 1 Female, 2 Other.
MaritalStatusMarital status.
SpouseNameSpouse's name.
OccupationOccupation.
PubliclyExposedPersonIndicates whether the person is publicly exposed.
CompanyTypeCompany type, as a number. Only for legal entities.
CompanyActivityCompany activity. Only for legal entities.
ConstitutionDateConstitution date, in the format yyyy-MM-dd. Only for legal entities.

GetRequestSigner

The values of the request status (RequestStatus) are in the Code Mapping, in the section Signer request status.

Request fields

FieldRequirementDescription
USNMandatoryIdentifier of the add request, returned by AddSigner.

Response fields

FieldDescription
Success"true" or "false".
RequestStatusStatus of the request, as text (for example, Gerada or Aprovado).
USNIdentifier of the request.
HolderDataData of the holder (the company).
HolderData.TaxNumberCNPJ of the holder.
HolderData.TrandingNameTrade name of the holder. The field is named TrandingName.
HolderData.ConstitutionDateConstitution date, in the format dd/MM/yyyy.
SignatoryDataData of the requested signer.
SignatoryData.NameName of the signer.
SignatoryData.TaxNumberCPF of the signer.
SignatoryData.BirthDateDate of birth, in the format dd/MM/yyyy.
SignatoryData.PersonRoleTypeRole of the signer, as text. The roles are in the Code Mapping, in the section Role of the person.
SignatoryData.JustificationJustification of the add request, in free text.

Specific errors

The errors returned by these methods are listed in the Error Catalogue, in the section GetSigners and GetRequestSigner.

Important rules

Adding a signer is a flow of its own, which goes through identity validation, documents, Compliance, Risk and BC Protege+. It is only completed after the final approval, and the account must be active and unblocked.

The signer webhook (Method FBWebhookWorkerUpdateSignerSolicitation) notifies the BU of the creation (Gerada), approval (Aprovado) or rejection (Reprovado) of the request. The Gerada notice is not sent in every case, and the manual removal of a signer does not generate this webhook. The BU must only update the signer link in its own system after the final result. If the signer is rejected, the BU must not link them, and must evaluate the cause by querying the request with GetRequestSigner. An active BC Protege+ restriction of the signer can reject the request and affect the associated company account. See more in BC Protege+.

The path of a signer addition request, from AddSigner to the check:

flowchart TD
  A["BU sends AddSigner"] --> B["Fits generates the USN"]
  B --> C["Analysis: identity, documents, Compliance, Risk and Protege+"]
  B -.->|"Does not always arrive"| D["Gerada webhook"]
  C --> E{"Final result webhook"}
  E -->|Aprovado| F["BU updates the signer link"]
  E -->|Reprovado| G["BU does not link and queries GetRequestSigner"]
  F --> H["GetSigners to check"]

Did this page help you?