Registration API

The Registration API allows you to tag a Provenance Blockchain account with your AML/KYC attribute. This will enable the account to hold and transfer USDF coin.

DCC Setup Note

DCC middleware is set up with a KYC_TAG_NAME environmental variable that is used as the key for tagging. The attribute name has historically be configured as bankname.kyc.pb. Since kyc.pb is a restricted namespace owned by Figure Tech, please contact them to support the initial namespace creation and access.

---

Register Address

POST /api/v1/registrations

Submit a Provenance Blockchain account as having opened a bank account at your institution. This publicly marks the address as having an account that has been properly onboarded at your bank with your bank's AML/KYC attribute.

Request

Sample Request

{
    "bankAccountUuid": "e886fda6-1ef2-4afb-85cd-05fc2a497929",
    "blockchainAddress": "tp1uuwul8w8385lsgjdq9gazwje5eulft42pde73e"
}

Response

Returns a string value of bankAccountUuid just registered.

Parameters

Attribute	Type	Requirement	Notes
bankAccountUuid	string	Required	Unique identifier of bank account at your institution
blockchainAddress	string	Required	Provenance Blockchain account associated with your bank account

Error Codes

400 - Bad Request

The body in the request is not valid.

500 - Internal Server Error

Some server error occurred.

---

Deregister Address

DELETE /api/v1/registrations/{uuid}

Remove the AML/KYC attribute from a previous registration for the given uuid. This prevents the Provenance Blockchain account from transferring or receiving additional USDF coin going forwards unless re-registered at a later time.

Request

N/A

Response

Returns a string value of bankAccountUuid just deregistered.

Error Codes

400 - Bad Request

The body in the request is not valid.

500 - Internal Server Error

Some server error occurred.