Create DICT proxy key

post

https://sandbox.numeral.io/v1/proxy_services/dict/proxy_keys

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Details required to register a DICT proxy key.

owner_type

string

enum

required

Whether the proxy key owner is an individual or a legal entity.

Allowed:

proxy_type

string

enum

required

The category of proxy identifier (phone number, email, tax ID, etc.).

Allowed:

proxy_type_code

string

enum

The scheme-specific sub-type code for the proxy. For DICT: cpf (individual) or cnpj (legal entity).

proxy_identification

string

required

The proxy identifier value (e.g. the CPF number, email address, or phone number).

owner_name

string

required

length ≤ 140

Full name of the proxy key owner. Maximum 140 characters.

account_identification

string

required

Account number associated with this proxy key.

account_type

string

enum

ISO 20022 account type code.

Allowed:

account_issuer

string

Identifier of the institution that issued the account (e.g. ISPB code for DICT).

servicer

string

required

Identifier of the financial institution servicing the account (e.g. ISPB for DICT).

connected_account_id

uuid

required

ID of the Mambu Payments connected account to register this proxy key against.

internal_account_id

uuid

Optional ID of an internal account in Mambu Payments linked to this proxy key.

scheme_data

object

required

DICT-specific input fields required when registering a proxy key.

metadata

object

Customer-defined key/value pairs passed through as-is.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully created proxy key

400Validation error.

409Conflict.