Pular para o conteúdo

Get addresses

Requisição

Get an address

Segurança
TokenAuth
Caminho
counterpartyIdstringobrigatório

The counterparty ID

addressIdstringobrigatório

The address ID

curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/wallet/api-docs/palisade-api/palisade-api/v2/counterparties/{counterpartyId}/addresses/{addressId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respostas

Corpoapplication/json
addressIdstringobrigatório

The address ID

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"
counterpartyIdstringobrigatório

The counterparty ID

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringobrigatório

The ID of the user who created this address

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring, (date-time)obrigatório

The date and time the address was created

Exemplo:"2022-03-29T10:22:22.420Z"
updatedBystringobrigatório

The ID of the user who updated this address

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"
updatedAtstring, (date-time)obrigatório

The date and time the address was updated

Exemplo:"2022-03-29T10:22:22.420Z"
custodianobject(v2Custodian)
termsAndConditionsAcceptedbooleanobrigatório

Whether the user has accepted the terms and conditions

Exemplo:true
detailsobject(v2AddressDetails)obrigatório

The address details

statusstring(v2AddressStatus)obrigatório

The address status

Enum:"CREATED""ENABLED""REJECTED""DELETED""ERROR""COMPLIANCE_PENDING""COMPLIANCE_COMPLETE""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""DELETION_APPROVAL_PENDING"
Exemplo:"PENDING"
activebooleanobrigatório

Whether the address is active

Exemplo:true
Resposta
{
  "addressId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "counterpartyId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "custodian": {
    "name": "Palisade Financial",
    "dId": "did:example:123456789abcdefghi"
  },
  "termsAndConditionsAccepted": true,
  "details": {
    "type": "EXTERNAL",
    "externalAddress": { … }
  },
  "status": "PENDING",
  "active": true
}